Upgrade installation & Create new release #9
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi @ecjoliver, thanks for putting together such a great package! It's been very helpful in my research. This PR addresses a difficulty I was having while using the package, so hopefully the fix helps make it easier for others as well.
Overview of this PR
The setup method recommended in the installation instructions (
python setup.py install
) has been deprecated and no longer works, so I'm wondering if you would be willing to update to usingpyproject.toml
, a more modern installation method. This PR does adds the files for building withpyproject.toml
. I included dependencies in thepyproject.toml
, so as a bonus dependencies are automatically installed instead of needing to be installed manually.What was done
These steps loosely follow this tutorial.
How to run it
The process to build the library with
pyproject.toml
is:python -m pip install --upgrade build
python -m build
That will create a
.tar.gz
file that can be used to pip install the library.How to test the output
To test the
.tar.gz
file one can:pip install /path/to/file/marineHeatWaves/dist/marineheatwaves-0.0.30.tar.gz
example_synthetic.ipynb
from docs folderNew Release & Distribution with PyPI
There have been lots of great fixes since the last official release in March 2016. It's great that there are so many fixes, but personally it took me a while to find out they existed because by default I installed the latest release.
Would you be willing to make a new release on github and add the lastest version to PyPI? Having that new release would also make it so that I could cite a specific version of this package in the paper I am getting ready to publish, as opposed to linking to a specific commit.
There are really nice steps for uploading to pypi here. The tutorial steps use a test version of pypi that the docs have setup for learning, but there is a summary of how to upload to the production version of pypi at the bottom of the tutorial.
Thanks for considering any of these changes, @ecjoliver. I hope they are helpful to you and the community!