Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plan refactoring of pyIRI2016 #12

Open
rilma opened this issue Jan 12, 2022 · 0 comments
Open

Plan refactoring of pyIRI2016 #12

rilma opened this issue Jan 12, 2022 · 0 comments
Assignees

Comments

@rilma
Copy link
Owner

rilma commented Jan 12, 2022

This issue aims for planning a comprehensive refactoring of pyIRI2016. Community is welcome to be part of the discussion. Topics to be considered are:

  1. Improvements / refactoring of CI/CD pipelines
    1.1. Moving to Github Actions as CI/CD execution environment
    1.2. Build Docker image and publish to a public/private repository (e.g. Docker Hub/Cloud, Github Packages)
    1.2.1Ansible could come in to rescue us!!!
    1.3. Build Python package (perhaps with poetry) and publish to a public repository (e.g. PyPI)
  2. Improvement / refactoring / planning of unit-testing cases
    2.1. Comprehensive testing cases through pytest
  3. Improvement of documentation
    3.1 Release a CHANGELOG
    3.2 Perhaps with MkDocs and publication through Github Pages
  4. Automate updates of Fortran code and coefficients from the original sources
    4.1 Retrieval of Fortran files and dependencies
    4.2 Through automated pull requests thus repository always includes the latest version of Fortran code and coefficients.
    4.3. Official Fortran source code is available here.
    4.4. Common files (e.g. CCIR and URSI coefficients) can be obtained from this link.
    4.5. Solar and magnetic indices can be found in this link

Serve yourself and please share comments / ideas ...

@rilma rilma self-assigned this Jan 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant