Skip to main content

Radio occultations

Project description

radiocc

license badge version badge python badge coverage badge pre-commit badge

Radio occulation


Installation | Roadmap | Contributing | License


Installation

The code is still in development, hence you can only get it on ROB Gitlab repo

You need to:

  • clone it
  • download poetry (a tool for dependency management and packaging in Python)
  • run
    poetry install
    
    inside the project to install the dependencies in a virtual environment (it should be done automatically, long time I didn't do it, if it does not let us know and we will do it together)
  • to check the virtual env is correctly set, use
    poetry env info
    
    and confirm you have something similar to:
    Virtualenv
    Python:         3.9.6
    Implementation: CPython
    Path:           /home/greg/.cache/pypoetry/virtualenvs/radiocc-6zeAPCek-py3.9
    Valid:          True
    
  • run
    poetry shell
    
    to activate the virtual environment, it can be useful for IDE and linters but not necessary because it is automatically activated at runtime.
  • create a folder RESULTS and a folder TO_PROCESS and place in the latter your MEX or MVN scenarios to be run run poetry run radiocc to run the code automatically on the scenarios to be processed.

Roadmap

  • improve old code for lisibility, portability and testing
  • improve CLI interface for parameter tuning
  • provide GUI interface for parameter tuning
  • provide GUI tool on graphs to set thresholds and corrections
  • provide a pip library and binary installation

Contributing

Evaluate code before commiting

We use the powerful tool pre-commit to automatically run a battery of tests on the code at commit runtime to:

  • avoid pushing code with warnings and errors
  • unify code formatting between developpers

The list of tests and hook scripts can be found here.

They consist in:

  • few git and file-system checks
  • flake8 (python static linter)
  • isort (python imports linter & fixer)
  • mypy (python type checker)
  • black (python code fixer)
  • running tests with pytest

You can install this development environment using

poetry run pre-commit install

Commiting

You can fork and ask for pull request on the dev branch (or any other excepted the main branch).

Depending on your access rights, you can also create a new branch from dev, develop on it and ask for a merge into the dev branch.

License

Licensed under the Apache 2.0 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

radiocc-0.3.9.tar.gz (42.2 kB view hashes)

Uploaded Source

Built Distribution

radiocc-0.3.9-py3-none-any.whl (50.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page