# radiocc
> Provide a tool to compute radio occulations for planetary missions.
---
[Requirements](#requirements) |
[Installation](#installation) |
[Usage](#usage) |
[Configuration](#configuration) |
[Roadmap](#roadmap) |
[License](#license)
---
## Requirements
### Ubuntu 21.10
```sh
sudo apt install -y python3-gi libgirepository1.0-dev libcairo2-dev
gobject-introspection gir1.2-gtk-3.0
```
### Fedora 35
```sh
sudo dnf install gcc cairo-devel pkg-config python3-devel
gobject-introspection-devel cairo-gobject-devel gtk3
```
## Installation
```sh
# Create directory.
mkdir radiocc && cd radiocc
# Create virtual environnement to install package and activate it.
# Please read: https://docs.python.org/3/library/venv.html
python -m venv .env
source .env/bin/activate
# Install radiocc
pip install radiocc
```
## Usage
If you use **radiocc** as a command-line, you should read the
[command line guide][command-line-guide file].
If you decide to use it from Python, you should read the
[library guide][library-guide file].
## Configuration
**radiocc**
+ runs a list of input folders gathered in a "to_process" folder
+ writes the ouputs and saves figures in a "results" folder
To understand the config file, you should read the
[config file guide][config-file-guide file].
## Roadmap
+ improve old code for lisibility, portability and testing
+ optimise code speed
+ improve CLI interface, library API and config file for parameter tuning
+ provide GUI interface for parameter tuning and application of corrections
## License
Licensed under the [Apache 2.0 license][license file].
[repo url]: https://gitlab-as.oma.be/radiocc/radiocc
[pypi url]: https://pypi.org/project/radiocc
[command-line-guide file]: ./command-line-guide.md
[library-guide file]: ./doc/usage/library-guide.md
[config-file-guide file]: ./doc/usage/config-file-guide.md
[license file]: ./doc/usage/LICENSE
Raw data
{
"_id": null,
"home_page": "https://gitlab-as.oma.be/radiocc/radiocc",
"name": "radiocc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<3.11",
"maintainer_email": "",
"keywords": "radio,occultation",
"author": "Ananya Krishnan",
"author_email": "ananyakrishnaniiserk@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3a/5a/f9b450657cfd65dcd009f13978f76d20ad2a2f190b609481596b8a1d26e7/radiocc-0.6.24.tar.gz",
"platform": null,
"description": "# radiocc\n\n> Provide a tool to compute radio occulations for planetary missions.\n\n---\n\n[Requirements](#requirements) |\n[Installation](#installation) |\n[Usage](#usage) |\n[Configuration](#configuration) |\n[Roadmap](#roadmap) |\n[License](#license)\n\n---\n\n## Requirements\n\n### Ubuntu 21.10\n\n```sh\nsudo apt install -y python3-gi libgirepository1.0-dev libcairo2-dev\ngobject-introspection gir1.2-gtk-3.0\n```\n\n### Fedora 35\n\n```sh\nsudo dnf install gcc cairo-devel pkg-config python3-devel\ngobject-introspection-devel cairo-gobject-devel gtk3\n```\n\n## Installation\n\n```sh\n# Create directory.\nmkdir radiocc && cd radiocc\n\n# Create virtual environnement to install package and activate it.\n# Please read: https://docs.python.org/3/library/venv.html\npython -m venv .env\nsource .env/bin/activate\n\n# Install radiocc\npip install radiocc\n```\n\n## Usage\n\nIf you use **radiocc** as a command-line, you should read the\n[command line guide][command-line-guide file].\n\nIf you decide to use it from Python, you should read the\n[library guide][library-guide file].\n\n## Configuration\n\n**radiocc**\n+ runs a list of input folders gathered in a \"to_process\" folder\n+ writes the ouputs and saves figures in a \"results\" folder\n\nTo understand the config file, you should read the\n[config file guide][config-file-guide file].\n\n## Roadmap\n\n+ improve old code for lisibility, portability and testing\n+ optimise code speed\n+ improve CLI interface, library API and config file for parameter tuning\n+ provide GUI interface for parameter tuning and application of corrections\n\n## License\n\nLicensed under the [Apache 2.0 license][license file].\n\n[repo url]: https://gitlab-as.oma.be/radiocc/radiocc\n[pypi url]: https://pypi.org/project/radiocc\n[command-line-guide file]: ./command-line-guide.md\n[library-guide file]: ./doc/usage/library-guide.md\n[config-file-guide file]: ./doc/usage/config-file-guide.md\n[license file]: ./doc/usage/LICENSE\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Radio occultations",
"version": "0.6.24",
"split_keywords": [
"radio",
"occultation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b07969f386f266b2ea394f6aaa8a857f85d954d5d7d3f3dd2d0da6a156920aa",
"md5": "dc4c290cdad7033be24021db82840e03",
"sha256": "5ad6727ab81ceb4ab2ac4771f39d7b8d18c9aa4c6b19fad8fcfb9a9206c65a41"
},
"downloads": -1,
"filename": "radiocc-0.6.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc4c290cdad7033be24021db82840e03",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.11",
"size": 129598,
"upload_time": "2023-01-09T09:56:37",
"upload_time_iso_8601": "2023-01-09T09:56:37.515272Z",
"url": "https://files.pythonhosted.org/packages/6b/07/969f386f266b2ea394f6aaa8a857f85d954d5d7d3f3dd2d0da6a156920aa/radiocc-0.6.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3a5af9b450657cfd65dcd009f13978f76d20ad2a2f190b609481596b8a1d26e7",
"md5": "4657a95472dde8e6264897e4ef89086e",
"sha256": "ce1bd7f8bee9bc3f56fac8d6bd5ea9c9516a2e129133bd45b221833f5c02e4ee"
},
"downloads": -1,
"filename": "radiocc-0.6.24.tar.gz",
"has_sig": false,
"md5_digest": "4657a95472dde8e6264897e4ef89086e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.11",
"size": 117274,
"upload_time": "2023-01-09T09:56:39",
"upload_time_iso_8601": "2023-01-09T09:56:39.172253Z",
"url": "https://files.pythonhosted.org/packages/3a/5a/f9b450657cfd65dcd009f13978f76d20ad2a2f190b609481596b8a1d26e7/radiocc-0.6.24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-09 09:56:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "radiocc"
}
JSON