jan/fatamorgana
2
1
Fork 1
Code Issues Pull Requests Releases Wiki Activity

Some minor docstring/readme updates

Browse Source
This commit is contained in:
Jan Petykiewicz 2020-04-17 13:51:43 -07:00
parent b5a7c9a7ad
commit 58b4f4a40f
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -26,12 +26,12 @@
Install with pip from PyPi (preferred): Install with pip from PyPi (preferred):
```bash ```bash
pip install fatamorgana pip3 install fatamorgana
``` ```
Install directly from git repository: Install directly from git repository:
```bash ```bash
pip install git+https://mpxd.net/code/jan/fatamorgana.git@release pip3 install git+https://mpxd.net/code/jan/fatamorgana.git@release
``` ```
## Documentation ## Documentation

8
fatamorgana/__init__.py
View File

@ -16,7 +16,13 @@
Dependencies: Dependencies:
- Python 3.5 or later - Python 3.5 or later
- numpy (optional, no additional functionality) - numpy (optional, faster but no additional functionality)
To get started, try:
```python3
import fatamorgana
help(fatamorgana.OasisLayout)
```
""" """
import pathlib import pathlib