worm-library 1.2.0

Download WORM Portal tutorial notebooks and files

worm_library

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

Installation

pip install worm_library

Usage

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
• Full Tutorial Library on GitHub

License

MIT License - see LICENSE for details.