Metadata-Version: 2.4
Name: worm_library
Version: 1.1.0
Summary: Download WORM Portal tutorial notebooks and files
Author-email: Grayson Boyer <gmboyer@asu.edu>
License-Expression: MIT
Project-URL: Homepage, https://github.com/worm-portal/WORM-Library
Project-URL: Repository, https://github.com/worm-portal/WORM-Library
Project-URL: Documentation, https://github.com/worm-portal/WORM-Library
Project-URL: Issues, https://github.com/worm-portal/WORM-Library/issues
Keywords: geochemistry,thermodynamics,aqueous,speciation,tutorials
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Chemistry
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: beautifulsoup4
Requires-Dist: lxml
Requires-Dist: pychnosz
Requires-Dist: aqequil
Requires-Dist: aqorg
Requires-Dist: propfit
Requires-Dist: complicator
Requires-Dist: wormutils
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: plotly
Requires-Dist: seaborn
Requires-Dist: kaleido
Requires-Dist: ipython
Requires-Dist: jupyter
Requires-Dist: jupyterlab
Dynamic: license-file

# worm_library

Download WORM Portal tutorial notebooks and demo files to your local environment.

## Installation

```bash
pip install worm_library
```

## Usage

```python
import worm_library

# Download the main WORM-Library notebook (index of all tutorials)
worm_library.get_library_notebook()

# Download specific tutorials
worm_library.get_worm_tour()                    # WORM Tour introduction
worm_library.get_introduction_demo()            # Basic introduction
worm_library.get_reaction_properties_demo()     # Reaction properties tutorials
worm_library.get_univariant_curve_demo()        # Univariant curves / geothermometry

# Aqueous speciation tutorials
worm_library.get_intro_aqueous_speciation_demo()
worm_library.get_multi_aqueous_speciation_demo()
worm_library.get_charge_balance_demo()
worm_library.get_heterogeneous_equilibrium_demo()
worm_library.get_heterogeneous_equilibrium_gas_demo()
worm_library.get_alter_suppress_demo()
worm_library.get_custom_data0_demo()
worm_library.get_EQ3_demo()
worm_library.get_EQ6_demo()

# Mass transfer tutorials
worm_library.get_intro_mass_transfer_demo()
worm_library.get_mass_transfer_feature_demo()
worm_library.get_mixing_demo()

# Additional tutorials
worm_library.get_speciation_datasets_demo()
worm_library.get_energy_supply_demo()

# Thermodynamic property estimation
worm_library.get_intro_aqorg_demo()
worm_library.get_aqorg_feature_demo()
worm_library.get_complicator_demo()
worm_library.get_estimate_HKF_demo()

# Community notebooks
worm_library.get_Weeks_2025_demo()
worm_library.get_Trinh_2026_demo()
worm_library.get_whats_in_water_demo()

# Workshop materials
worm_library.get_workshop_demo("workshop_name")

# Clean up all downloaded demos
worm_library.delete_all_demos()
```

Each function downloads the relevant notebooks and data files to a `Demo-*` folder in your current working directory.

## Links

- [WORM Portal](https://worm-portal.asu.edu/)
- [Full Tutorial Library on GitHub](https://github.com/worm-portal/WORM-Library)

## License

MIT License - see [LICENSE](LICENSE) for details.
