Skip to content

Commit

Permalink
update docs about runtime errors with numpy
Browse files Browse the repository at this point in the history
  • Loading branch information
vinay0000 committed Mar 3, 2022
1 parent f19df6d commit 64d40dd
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ cesium_app/Source/SampleData/eosim_data.czml
core
*.csv

# files
debug.log

# compiled Python
*.pyc

Expand Down
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ help:

all: bare install

install:
install:
# cartopy installation to be done prior to this. If using conda, can be done using the command `conda install -c conda-forge cartopy`
# In case of Runtime errors involving numpy (after installation), try the following command: `pip install numpy --upgrade --ignore-installed`
pip install -e .

clean: docs_clean
Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,19 @@ Run the application using the following command from terminal:
python bin/eosimapp.py
```

### Known Issues
In some cases, *runtime* errors involving the numpy package such as the one below may ensue:
```
module compiled against API version 0xf but this version of numpy is 0xe
```

This may be due to incompatile numpy package installation.
Please run the below command to fix it:
```
pip install numpy --upgrade --ignore-installed
```


## Cesium App
The Cesium JavaScript app is based on the showcased example of Cesium features in the *cesium-workshop* repository. It is contained in the `.\cesium_app\` folder.

Expand Down
4 changes: 4 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,9 @@ def readme():
packages=['eosim'],
scripts=[
],
# Cartopy installation may not work due to additional dependencies it requires.
# CartoPy dependencies must be installed before running this setup.
# If using conda, cartopy along with its dependencies can be installed using the command `conda install -c conda-forge cartopy`
# In case of Runtime errors involving numpy, try the following command: `pip install numpy --upgrade --ignore-installed`
install_requires=['numpy', 'pandas', 'scipy', 'lowtran', 'astropy', 'cartopy']
)

0 comments on commit 64d40dd

Please sign in to comment.