search

acroucher / PyTOUGH

A Python library for automating TOUGH2 simulations of subsurface fluid and heat flow
GNU Lesser General Public License v3.0
96 stars 36 forks source link

Distribute package on PyPI? #55

Closed matthewfeickert closed 6 months ago

matthewfeickert commented 7 months ago

:wave: @acroucher would you be open to the idea of publishing and distributing PyTOUGH on PyPI? This has become relevant in at least one case for a paper review (c.f. https://github.com/openjournals/joss-reviews/issues/6125#issuecomment-1901093941).

If so (great!), if you have any questions about how to do so, please check the Python Packaging User Guide's section on Packaging Python Projects and the Scientific Python Development Guide topical guide on packaging which includes information on how to get started with deployment to PyPI.

acroucher commented 6 months ago

I've just released version 1.6.0 which has pip install from PyPI and modernized packaging using pyproject.toml (as well as migrating the PDF user guide to Read the Docs).

matthewfeickert commented 6 months ago

@acroucher great and thanks! Everything looks good

$ docker run --rm -ti python:3.11 /bin/bash
root@ab87aadd85a9:/# python -m venv venv && . venv/bin/activate
(venv) root@ab87aadd85a9:/# python -m pip --quiet install --upgrade pip
(venv) root@ab87aadd85a9:/# python -m pip install PyTOUGH
...
Successfully installed PyTOUGH-1.6.0 contourpy-1.2.0 cycler-0.12.1 fonttools-4.49.0 kiwisolver-1.4.5 matplotlib-3.8.3 numpy-1.26.4 packaging-23.2 pillow-10.2.0 pyparsing-3.1.1 python-dateutil-2.8.2 scipy-1.12.0 six-1.16.0
(venv) root@ab87aadd85a9:/# python -m pip show PyTOUGH
Name: PyTOUGH
Version: 1.6.0
Summary: Python scripting library for TOUGH2 simulation
Home-page: 
Author: 
Author-email: Adrian Croucher <a.croucher@auckland.ac.nz>
License: GNU LESSER GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007
...
Location: /venv/lib/python3.11/site-packages
Requires: matplotlib, numpy, scipy
Required-by: 
(venv) root@ab87aadd85a9:/#