-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from jacobwilliams/refactor
Refactor
- Loading branch information
Showing
30 changed files
with
2,651 additions
and
193 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| name: CI | ||
| on: [push] | ||
| jobs: | ||
|
|
||
| Build: | ||
| runs-on: ${{ matrix.os }} | ||
| permissions: | ||
| contents: write | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| os: [ubuntu-latest] | ||
| gcc_v: [10] # Version of GFortran we want to use. | ||
| python-version: [3.9] | ||
| env: | ||
| FC: gfortran-${{ matrix.gcc_v }} | ||
| GCC_V: ${{ matrix.gcc_v }} | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| submodules: recursive | ||
|
|
||
| - name: Install Python | ||
| uses: actions/setup-python@v4 # Use pip to install latest CMake, & FORD/Jin2For, etc. | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
|
|
||
| - name: Setup Graphviz | ||
| uses: ts-graphviz/setup-graphviz@v1 | ||
|
|
||
| - name: Setup Fortran Package Manager | ||
| uses: fortran-lang/setup-fpm@v5 | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Install Python dependencies | ||
| if: contains( matrix.os, 'ubuntu') | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install ford numpy matplotlib | ||
| if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | ||
| - name: Install GFortran Linux | ||
| if: contains( matrix.os, 'ubuntu') | ||
| run: | | ||
| sudo apt-get install lcov | ||
| sudo add-apt-repository ppa:ubuntu-toolchain-r/test | ||
| sudo apt-get update | ||
| sudo apt-get install -y gcc-${{ matrix.gcc_v }} gfortran-${{ matrix.gcc_v }} | ||
| sudo update-alternatives \ | ||
| --install /usr/bin/gcc gcc /usr/bin/gcc-${{ matrix.gcc_v }} 100 \ | ||
| --slave /usr/bin/gfortran gfortran /usr/bin/gfortran-${{ matrix.gcc_v }} \ | ||
| --slave /usr/bin/gcov gcov /usr/bin/gcov-${{ matrix.gcc_v }} | ||
| # - name: Compile | ||
| # run: fpm build --profile release | ||
|
|
||
| - name: Run tests | ||
| run: fpm test --profile debug --flag -coverage | ||
|
|
||
| - name: Create coverage report | ||
| run: | | ||
| mkdir -p ${{ env.COV_DIR }} | ||
| mv ./build/gfortran_*/*/* ${{ env.COV_DIR }} | ||
| lcov --capture --initial --base-directory . --directory ${{ env.COV_DIR }} --output-file ${{ env.COV_DIR }}/coverage.base | ||
| lcov --capture --base-directory . --directory ${{ env.COV_DIR }} --output-file ${{ env.COV_DIR }}/coverage.capture | ||
| lcov --add-tracefile ${{ env.COV_DIR }}/coverage.base --add-tracefile ${{ env.COV_DIR }}/coverage.capture --output-file ${{ env.COV_DIR }}/coverage.info | ||
| env: | ||
| COV_DIR: build/coverage | ||
|
|
||
| - name: Upload coverage report | ||
| uses: codecov/codecov-action@v3 | ||
| with: | ||
| files: build/coverage/coverage.info | ||
|
|
||
| - name: Build documentation | ||
| run: ford ./ford.md | ||
|
|
||
| - name: Deploy Documentation | ||
| if: github.ref == 'refs/heads/master' | ||
| uses: JamesIves/[email protected] | ||
| with: | ||
| branch: gh-pages # The branch the action should deploy to. | ||
| folder: doc # The folder the action should deploy. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,3 +39,4 @@ | |
| /doc | ||
| /lib | ||
| /bin | ||
| /archive | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,45 @@ | ||
| National Space Science Data Center Data set PT-11B Mar 1996 | ||
| Radbelt: Work in progress to refactor the AE-8/AP-8 Van Allen belt model. | ||
|
|
||
| ### Status | ||
|
|
||
| [](https://github.com/topics/fortran) | ||
| [](https://github.com/jacobwilliams/radbelt/releases/latest) | ||
| [](https://github.com/jacobwilliams/radbelt/actions) | ||
| [](https://codecov.io/gh/jacobwilliams/radbelt) | ||
| [](https://github.com/jacobwilliams/radbelt/commits/master) | ||
|
|
||
| ### Compiling | ||
|
|
||
| A [Fortran Package Manager](https://github.com/fortran-lang/fpm) manifest file is included, so that the library and test cases can be compiled with FPM. For example: | ||
|
|
||
| ``` | ||
| fpm build --profile release | ||
| fpm test --profile release | ||
| ``` | ||
|
|
||
| To use `radbelt` within your fpm project, add the following to your `fpm.toml` file: | ||
| ```toml | ||
| [dependencies] | ||
| radbelt = { git="https://github.com/jacobwilliams/radbelt.git" } | ||
| ``` | ||
|
|
||
| ### Documentation | ||
|
|
||
| The latest API documentation can be found [here](https://jacobwilliams.github.io/radbelt/). This was generated from the source code using [FORD](https://github.com/Fortran-FOSS-Programmers/ford). | ||
|
|
||
| ### See also | ||
|
|
||
| * [NASA ModelWebArchive](https://git.smce.nasa.gov/ccmc-share/modelwebarchive) | ||
| * [An Astropy-friendly wrapper for the AE-8/AP-8 Van Allen belt model](https://github.com/nasa/radbelt) | ||
| * [pyIGRF](https://github.com/rilma/pyIGRF) | ||
| * https://github.com/lanl/RAM-SCB/blob/master/srcExternal/igrf.f | ||
| * https://github.com/space-physics/igrf/blob/main/src/igrf/fortran/igrf13.f | ||
|
|
||
|
|
||
|
|
||
| # Original Readme | ||
|
|
||
| National Space Science Data Center Data set PT-11B Mar 1996 | ||
| ========================================================================= | ||
|
|
||
| ``` | ||
|
|
@@ -12,7 +53,7 @@ SOURCE: Dieter Bilitza, GSFC/NSSDC code 633, Greenbelt, | |
| [email protected] | ||
| CONTENT: 12 files *.* blocks | ||
| FORTRAN source code: | ||
| FORTRAN source code: | ||
| driver program with interface RADBELT.FOR 48 | ||
| subroutines, functions TRMFUN.FOR 30 | ||
|
|
@@ -34,48 +75,43 @@ CONTENT: 12 files *.* blocks | |
|
|
||
| These empirical models describe the differential or | ||
| integral, omnidirectional fluxes of electrons (AE-8) and protons | ||
| (AP-8) in the inner and outer radiation belts (electrons: L=1.1 | ||
| to 11, protons: L=1.1 to 7) for two epochs representing solar | ||
| maximum (1970) and minimum (1964) conditions. The energy spectrum | ||
| ranges from 0.1 to 400 MeV for the protons and from 0.04 to 7 MeV | ||
| for the electrons. AE-8 and AP-8 are the most recent ones in a | ||
| series of models established by J. Vette and his colleges at NSSDC | ||
| starting in the early sixties. The models are based on almost all | ||
| (AP-8) in the inner and outer radiation belts (electrons: L=1.1 | ||
| to 11, protons: L=1.1 to 7) for two epochs representing solar | ||
| maximum (1970) and minimum (1964) conditions. The energy spectrum | ||
| ranges from 0.1 to 400 MeV for the protons and from 0.04 to 7 MeV | ||
| for the electrons. AE-8 and AP-8 are the most recent ones in a | ||
| series of models established by J. Vette and his colleges at NSSDC | ||
| starting in the early sixties. The models are based on almost all | ||
| available satellite data. It is IMPORTANT that the models maps for | ||
| solar maximum are used with a magnetic field model for epoch=1970 | ||
| and for solar minimum for epoch=1964. | ||
|
|
||
| For each epoch and particle the model consists of a three- | ||
| dimensional table of (logarithm of) particle fluxes in energy, L-value, | ||
| and B/B0 (magnetic field strength normalized to the equator). The program | ||
| MODEL finds the particle fluxes for given energy, L-value and B/B0 by | ||
| interpolating in energy (subroutine TRARA1) and in L * B/B0 space (TRARA2). | ||
| dimensional table of (logarithm of) particle fluxes in energy, L-value, | ||
| and B/B0 (magnetic field strength normalized to the equator). The program | ||
| MODEL finds the particle fluxes for given energy, L-value and B/B0 by | ||
| interpolating in energy (subroutine TRARA1) and in L * B/B0 space (TRARA2). | ||
| The program RADBELT produces tables of integral or differential fluxes | ||
| for different energies varying with L or B/B0. | ||
|
|
||
| The coefficient files are provided in VAX/VMS binary (*.bin) and | ||
| ASCII (*.asc) format. For all systems other than VMS the use of the ASCII | ||
| files is recommended. If using the ASCII coefficient one needs to slightly | ||
| files is recommended. If using the ASCII coefficient one needs to slightly | ||
| modify the RADBELT.FOR program as described in a comment statement in | ||
| RADBELT (this comments are found after the OPEN statement for the coefficient | ||
| RADBELT (this comments are found after the OPEN statement for the coefficient | ||
| file). | ||
|
|
||
| In March 1995 the earlier used compressed model maps AP8MIC and AP8MAC | ||
| were replaced with the full maps AP8MIN/MAX with the help of D. Heynderickx | ||
| (BIRA, Brussel, Belgium) and A. Beliaev (INP/MSU, Moscow, Russia). Heynderickx | ||
| and Beliaev (1995) had found and corrected a small error in the AP8MIN map; | ||
| were replaced with the full maps AP8MIN/MAX with the help of D. Heynderickx | ||
| (BIRA, Brussel, Belgium) and A. Beliaev (INP/MSU, Moscow, Russia). Heynderickx | ||
| and Beliaev (1995) had found and corrected a small error in the AP8MIN map; | ||
| two lines had been exchanged. | ||
|
|
||
| ### AVAILABILITY: | ||
|
|
||
| (1) FORTRAN source code from this directory. | ||
| (2) Model parameters can be computed and plotted online at http://nssdc.gsfc.nasa.gov/space/model/ . | ||
|
|
||
|
|
||
| ### See also | ||
|
|
||
| * [NASA ModelWebArchive](https://git.smce.nasa.gov/ccmc-share/modelwebarchive) | ||
|
|
||
| ### REFERENCES: | ||
|
|
||
| G.W. Singley, and J.I. Vette, The AE-4 Model of the Outer Radiation | ||
|
|
@@ -102,16 +138,16 @@ M.T. Teague, N.J. Schofield, K.W. Chan, and J.I. Vette, A Study of | |
| Inner Zone Electron Data and their Comparison with Trapped | ||
| Radiation Models, NSSDC/WDC-A-R&S 79-06, 1979. | ||
|
|
||
| J.I. Vette, The AE-8 Trapped Electron Model Environment, | ||
| J.I. Vette, The AE-8 Trapped Electron Model Environment, | ||
| NSSDC/WDC-A-R&S 91-24, 1991. | ||
|
|
||
| J.I. Vette, The NASA/National Space Science Data Center Trapped | ||
| Radiation Environment Model Program (1964-1991), NSSDC/WDC-A-R&S | ||
| J.I. Vette, The NASA/National Space Science Data Center Trapped | ||
| Radiation Environment Model Program (1964-1991), NSSDC/WDC-A-R&S | ||
| 91-29, 1991. | ||
|
|
||
| (most of these references are available from NSSDC) | ||
|
|
||
| D. Heynderickx and A. Beliaev, J. Spacecraft and Rockets 32, 190-192, 1995. | ||
|
|
||
| National Space Science Data Center Data set PT-11B Mar 1996 | ||
| National Space Science Data Center Data set PT-11B Mar 1996 | ||
| ========================================================================= | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| comment: | ||
| layout: header, changes, diff, sunburst | ||
| coverage: | ||
| ignore: | ||
| - test | ||
| - doc | ||
| status: | ||
| patch: | ||
| default: | ||
| target: 10% | ||
| project: | ||
| default: | ||
| target: 10% |
Oops, something went wrong.