Skip to content

Commit

Permalink
add ninja prereqs
Browse files Browse the repository at this point in the history
  • Loading branch information
scivision committed Nov 12, 2019
1 parent 642544c commit 8870a9b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 13 deletions.
5 changes: 2 additions & 3 deletions .github/workflows/ci.yml
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Install Prereqs
run: |
sudo apt update -yq
sudo apt install -yq --no-install-recommends ninja-build gfortran
sudo apt install -yq --no-install-recommends gfortran
- run: pip install .[tests,lint]
- run: flake8
- run: mypy .
Expand All @@ -37,7 +37,7 @@ jobs:
- uses: actions/setup-python@v1
with:
python-version: '3.x'
- run: brew install gcc ninja
- run: brew install gcc
- run: pip install .[tests]
- run: pytest
working-directory: tests
Expand All @@ -52,7 +52,6 @@ jobs:
- uses: actions/setup-python@v1
with:
python-version: '3.x'
- run: cinst -y ninja
- run: pip install .[tests]
- run: pytest
working-directory: tests
Expand Down
16 changes: 7 additions & 9 deletions README.md
Expand Up @@ -11,20 +11,13 @@
![image](./figures/iri2DExample02.gif)

Python and [Matlab](#matlab) interfaces to the International Reference Ionosphere (IRI) 2016 model.
A Fortran compiler and CMake or
[Meson](https://github.com/mesonbuild/meson/)
is required to build the IRI2016 code.
A Fortran compiler is required to build the IRI2016 code.

## Install

**Prerequisites**

* Python >= 3.6
* Ninja-build obtained by:
* Linux: `apt install ninja-build`
* MacOS/Homebrew: `brew install ninja`
* Windows Chocolatey: `cinst -y ninja`
* [direct download](https://github.com/ninja-build/ninja/releases) and extract, put directory in PATH environment variable.
* Fortran compiler--just about any modern Fortran compiler will do. Here's how to get Gfortran:
* Linux: `apt install gfortran`
* Mac: `brew install gcc`
Expand All @@ -44,6 +37,10 @@ git clone https://github.com/space-physics/iri2016
pip install -e iri2016
```

This Python wrapper of IRI2016 uses our build-on-run technique.
The first time you use IRI2016, you will see messages from the Meson build system and your C compiler.


## Usage

* Altitude Profile: plot density and temperatures vs altitude
Expand Down Expand Up @@ -73,8 +70,9 @@ pip install -e iri2016
![image](./figures/iri2DExample02.png)

### Matlab / GNU Octave

IRI2016 is readily accessible from Matlab and GNU Octave.
From within Matlab/Octave, verify everything is working by from the `iri2016/tests` directory:
From within Matlab / Octave, verify everything is working by from the `iri2016/tests` directory:

```matlab
test_iri2016
Expand Down
3 changes: 2 additions & 1 deletion setup.cfg
@@ -1,6 +1,6 @@
[metadata]
name = iri2016
version = 1.8.3
version = 1.8.4
author = Michael Hirsch, Ph.D.; Ronald Ilma
author_email = scivision@users.noreply.github.com
description = IRI2016 International Reference Ionosphere from Python
Expand Down Expand Up @@ -30,6 +30,7 @@ packages = find:
zip_safe = false
install_requires =
meson
ninja
python-dateutil
numpy >= 1.10
xarray
Expand Down

0 comments on commit 8870a9b

Please sign in to comment.