Skip to content

Latest commit

 

History

History

jupyterbook

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Create docs

Install jupyter-book and ghp-import. From the main directory run

make build-jupyterbook
# Check doc in local looks good

# Upload the doc to GitHub
ghp-import -n -p -f jupyterbook/_build/html

The commit should appear in branch gh-pages and the page will be live at spaceml-org.github.io/ml4floods

Publish package in pip

Install twine.

First update the version number in ml4floods/__init__.py

rm -rf build/
rm -rf dist/
python setup.py sdist bdist_wheel

# upload to testpypi
python -m twine upload --repository testpypi dist/*

# Upload to real pypi
python -m twine upload dist/*

The package in PyPi will be shown at pypi.org/project/ml4floods/. The test version can be checked at test.pypi.org/project/ml4floods/

Follow this tutorial to understand how pip works