musica 0.11.1.4__cp312-cp312-win32.whl → 0.12.0__cp312-cp312-win32.whl

{musica-0.11.1.4.dist-info → musica-0.12.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: musica
-Version: 0.11.1.4
+Version: 0.12.0
 Summary: MUSICA is a Python library for performing computational simulations in atmospheric chemistry.
 Author-Email: Matthew Dawsom <mattdawson@ucar.edu>, Jiwon Gim <jiwongim@ucar.edu>, David Fillmore <fillmore@ucar.edu>, Kyle Shores <kshores@ucar.edu>, Montek Thind <mthind@ucar.edu>
 Maintainer-Email: ACOM MUSICA Developers <musica-support@ucar.edu>
@@ -207,6 +207,7 @@ License:                                  Apache License
             limitations under the License.
          
 Project-URL: homepage, https://wiki.ucar.edu/display/MUSICA/MUSICA+Home
+Requires-Dist: pyyaml>=6.0.2
 Provides-Extra: test
 Requires-Dist: numpy; extra == "test"
 Requires-Dist: pytest; extra == "test"
@@ -233,13 +234,21 @@ Multi-Scale Infrastructure for Chemistry and Aerosols
 MUSICA is a collection of modeling software, tools, and grids, that
 allow for robust modeling of chemistry in Earth's atmosphere.
 
-At present the project encompasses these components
+At present the project encompasses these core components
 - [TUV-x](https://github.com/NCAR/tuv-x)
     - A photolysis rate calculator 
 
 - [MICM](https://github.com/NCAR/micm)
     - Model Independent Chemical Module
 
+- [Mechanism Configuration](https://github.com/NCAR/MechanismConfiguration)
+    - The standardized format to describe atmospheric chemistry
+
+These components are used to drive the MUSICA software ecosystem. This is a snapshot of how MUSICA can be used with different
+models.
+
+![MUSICA Ecosystem](docs/source/_static/ecosystem.png)
+
 # Installation
 MUSICA is installable via pip for Python or CMake for C++. 
 
@@ -247,6 +256,7 @@ MUSICA is installable via pip for Python or CMake for C++.
 ```
 pip install musica
 ```
+
 ## CMake
 ```
 $ git clone https://github.com/NCAR/musica.git
@@ -343,17 +353,13 @@ import matplotlib.pyplot as plt
 df.plot(x='time.s', y=['CONC.A.mol m-3', 'CONC.B.mol m-3', 'CONC.C.mol m-3'], title='Concentration over time', ylabel='Concentration (mol m-3)', xlabel='Time (s)')
 plt.show()
 ```
-# Available grids
 
+# Available grids
 Pre-made grids for use in MUSICA are available [here](https://wiki.ucar.edu/display/MUSICA/Available+Grids).
 
-# Contributors guide
-Checkout our [software development plan](docs/Software%20Development%20Plan.pdf)
-to see how you can contribute new science to MUSICA software.
-
 ## Developer Options
 
-### Specifying dependency versions via paramaterization at configure time
+### Specifying dependency versions via parameterization at configure time
 
 Introduced in [Pull Request #124](https://github.com/NCAR/musica/pull/124), it is possible for developers to specify which versions of various dependencies should be used. These options are currently limited to those dependencies managed via `FetchContent`.  This change allows for more easily testing `musica` against changes committed in different repositories and branches.  The environmental variables introduced are outlined in the following table. 
 
@@ -365,6 +371,7 @@ Introduced in [Pull Request #124](https://github.com/NCAR/musica/pull/124), it i
 | [MICM](https://github.com/NCAR/mcim.git)               | MICM_GIT_REPOSITORY       | MICM_GIT_TAG       | 
 | [TUV-X](https://github.com/NCAR/tuv-x.git)             | TUVX_GIT_REPOSITORY       | TUVX_GIT_TAG       |
 | [PyBind11](https://github.com/pybind/pybind11)         | PYBIND11_GIT_REPOSITORY   | PYBIND11_GIT_TAG   |
+| [Mechanism Configuration](https://github.com/NCAR/MechanismConfiguration.git) | MECH_CONFIG_GIT_REPOSITORY | MECH_CONFIG_GIT_TAG |
 
 #### Example Usage
 
@@ -416,41 +423,49 @@ variable `BUILD_GPU`.
 BUILD_GPU=1 pip install -e .
 ```
 
-## Citing MUSICA
-
-MUSICA can be cited in at least two ways. The first is to cite [the paper](https://doi.org/10.1175/BAMS-D-19-0331.1) that defines the vision
-of the MUSICA software. The bibtex entry below can be used to generate a citaiton for this.
-
-```
-@Article { acom.software.musica-vision,
-    author = "Gabriele G. Pfister and Sebastian D. Eastham and Avelino F. Arellano and Bernard Aumont and Kelley C. Barsanti and Mary C. Barth and Andrew Conley and Nicholas A. Davis and Louisa K. Emmons and Jerome D. Fast and Arlene M. Fiore and Benjamin Gaubert and Steve Goldhaber and Claire Granier and Georg A. Grell and Marc Guevara and Daven K. Henze and Alma Hodzic and Xiaohong Liu and Daniel R. Marsh and John J. Orlando and John M. C. Plane and Lorenzo M. Polvani and Karen H. Rosenlof and Allison L. Steiner and Daniel J. Jacob and Guy P. Brasseur",
-    title = "The Multi-Scale Infrastructure for Chemistry and Aerosols (MUSICA)",
-    journal = "Bulletin of the American Meteorological Society",
-    year = "2020",
-    publisher = "American Meteorological Society",
-    address = "Boston MA, USA",
-    volume = "101",
-    number = "10",
-    doi = "10.1175/BAMS-D-19-0331.1",
-    pages= "E1743 - E1760",
-    url = "https://journals.ametsoc.org/view/journals/bams/101/10/bamsD190331.xml"
-}
-```
-
-At present MUSICA is on version zero. MUSICAv0 can be cited using the bibtex entry below.
-MUSICAv0 description and evaluation:
-
-```
-@Article{acom.software.musica,
-    author = {Schwantes, Rebecca H. and Lacey, Forrest G. and Tilmes, Simone and Emmons, Louisa K. and Lauritzen, Peter H. and Walters, Stacy and Callaghan, Patrick and Zarzycki, Colin M. and Barth, Mary C. and Jo, Duseong S. and Bacmeister, Julio T. and Neale, Richard B. and Vitt, Francis and Kluzek, Erik and Roozitalab, Behrooz and Hall, Samuel R. and Ullmann, Kirk and Warneke, Carsten and Peischl, Jeff and Pollack, Ilana B. and Flocke, Frank and Wolfe, Glenn M. and Hanisco, Thomas F. and Keutsch, Frank N. and Kaiser, Jennifer and Bui, Thao Paul V. and Jimenez, Jose L. and Campuzano-Jost, Pedro and Apel, Eric C. and Hornbrook, Rebecca S. and Hills, Alan J. and Yuan, Bin and Wisthaler, Armin},
-    title = {Evaluating the Impact of Chemical Complexity and Horizontal Resolution on Tropospheric Ozone Over the Conterminous US With a Global Variable Resolution Chemistry Model},
-    journal = {Journal of Advances in Modeling Earth Systems},
-    volume = {14},
-    number = {6},
-    pages = {e2021MS002889},
-    doi = {https://doi.org/10.1029/2021MS002889},
-    url = {https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/2021MS002889},
-    eprint = {https://agupubs.onlinelibrary.wiley.com/doi/pdf/10.1029/2021MS002889},
-    year = {2022}
-}
-```
+# Contributing
+
+We welcome contributions from the community! Please see our [Contributing Guide](CONTRIBUTING.md) for information on how to get involved.
+
+For a complete list of contributors and authors, see [AUTHORS.md](AUTHORS.md).
+
+# Citations
+
+MUSICA can be cited in at least two ways:
+
+1. **Cite the foundational paper** that defines the vision of the MUSICA software:
+    - [Pfister et al., 2020, Bulletin of the American Meteorological Society](https://doi.org/10.1175/BAMS-D-19-0331.1)
+    - Use the following BibTeX entry:
+      ```
+      @Article { acom.software.musica-vision,
+          author = "Gabriele G. Pfister and Sebastian D. Eastham and Avelino F. Arellano and Bernard Aumont and Kelley C. Barsanti and Mary C. Barth and Andrew Conley and Nicholas A. Davis and Louisa K. Emmons and Jerome D. Fast and Arlene M. Fiore and Benjamin Gaubert and Steve Goldhaber and Claire Granier and Georg A. Grell and Marc Guevara and Daven K. Henze and Alma Hodzic and Xiaohong Liu and Daniel R. Marsh and John J. Orlando and John M. C. Plane and Lorenzo M. Polvani and Karen H. Rosenlof and Allison L. Steiner and Daniel J. Jacob and Guy P. Brasseur",
+          title = "The Multi-Scale Infrastructure for Chemistry and Aerosols (MUSICA)",
+          journal = "Bulletin of the American Meteorological Society",
+          year = "2020",
+          publisher = "American Meteorological Society",
+          address = "Boston MA, USA",
+          volume = "101",
+          number = "10",
+          doi = "10.1175/BAMS-D-19-0331.1",
+          pages= "E1743 - E1760",
+          url = "https://journals.ametsoc.org/view/journals/bams/101/10/bamsD190331.xml"
+      }
+      ```
+
+2. **Cite the MUSICA software and its evaluation** (MUSICAv0):
+    - [Schwantes et al., 2022, Journal of Advances in Modeling Earth Systems](https://doi.org/10.1029/2021MS002889)
+    - Use the following BibTeX entry:
+      ```
+      @Article{acom.software.musica,
+          author = {Schwantes, Rebecca H. and Lacey, Forrest G. and Tilmes, Simone and Emmons, Louisa K. and Lauritzen, Peter H. and Walters, Stacy and Callaghan, Patrick and Zarzycki, Colin M. and Barth, Mary C. and Jo, Duseong S. and Bacmeister, Julio T. and Neale, Richard B. and Vitt, Francis and Kluzek, Erik and Roozitalab, Behrooz and Hall, Samuel R. and Ullmann, Kirk and Warneke, Carsten and Peischl, Jeff and Pollack, Ilana B. and Flocke, Frank and Wolfe, Glenn M. and Hanisco, Thomas F. and Keutsch, Frank N. and Kaiser, Jennifer and Bui, Thao Paul V. and Jimenez, Jose L. and Campuzano-Jost, Pedro and Apel, Eric C. and Hornbrook, Rebecca S. and Hills, Alan J. and Yuan, Bin and Wisthaler, Armin},
+          title = {Evaluating the Impact of Chemical Complexity and Horizontal Resolution on Tropospheric Ozone Over the Conterminous US With a Global Variable Resolution Chemistry Model},
+          journal = {Journal of Advances in Modeling Earth Systems},
+          volume = {14},
+          number = {6},
+          pages = {e2021MS002889},
+          doi = {https://doi.org/10.1029/2021MS002889},
+          url = {https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/2021MS002889},
+          eprint = {https://agupubs.onlinelibrary.wiley.com/doi/pdf/10.1029/2021MS002889},
+          year = {2022}
+      }
+      ```

musica-0.12.0.dist-info/RECORD

@@ -0,0 +1,57 @@
+musica/__init__.py,sha256=-TtiqPge1QqHDQHJLZb1S13378oCvioqxveGFsTG1K4,1799
+musica/_musica.cp312-win32.pyd,sha256=zBxECdQUIhEmcOyiFFbRaYXj4orfhODOuCv_vTYR2xs,1261568
+musica/_version.py,sha256=9e9mHDi2fUgxlhglOE73A-PATsMwCeXLJ4vRvu3ZC2A,20
+musica/binding_common.cpp,sha256=A1Y5LxGjWXi09Eczv06H5iJC-9i0R9eya2ehz2jnD9U,575
+musica/binding_common.hpp,sha256=YAcb9WnfXL7Ps-rR-iMBSwUgBQZfZZdCQQod5CTMEZA,108
+musica/CMakeLists.txt,sha256=qRSE9QuzRR1go16-ujVBHpkdHf-5dCuPZLbCrP7ygHc,1092
+musica/constants.py,sha256=o0PjiiTyGMdCPWmBewiQKaX-JBOR6vkz1n0pAacuZNU,124
+musica/cpu_binding.cpp,sha256=J-9SfvuXeWYvOAwX5luG6f5DieV0pchkutRAJ3xoN2Y,234
+musica/cuda.cpp,sha256=oTG2ZnL-SiW2kx9eL4XJOQGJeIiGuy8tJ5BEoLRWL4M,358
+musica/cuda.py,sha256=6Qe6cBbPN9K5Uqu7wBt18zTUjRIgvnQKBJZr6tHJrs8,234
+musica/gpu_binding.cpp,sha256=sv1_exUAhGRXY0kzT_q-f0Yl_GYgkYRKwmqWGSi0Qx8,238
+musica/mechanism_configuration/__init__.py,sha256=WVIbDCgpAd-jH9TBPou-5tyrdxb5Vbm9Zl2h7xmNiQ8,38
+musica/mechanism_configuration/aqueous_equilibrium.py,sha256=O0QuSk-kwc4DKslOeiqgR0E2YrrJhl_BKI-CwNRQzlM,4861
+musica/mechanism_configuration/arrhenius.py,sha256=oEVg7_5XXpiiSeVEOW3_567gHVekvr8kADOBTSqFokM,5268
+musica/mechanism_configuration/branched.py,sha256=MjWJl86BbhJj7M85QRqhiFIyGwzI9u8R2z_oeOIvYLg,5331
+musica/mechanism_configuration/condensed_phase_arrhenius.py,sha256=rUluAt0z_Q79apJKnpC20Ng9Jk1wk5YPn8tvtzXv0wo,5477
+musica/mechanism_configuration/condensed_phase_photolysis.py,sha256=KTebLSs6Hakd4p4oqkGftHgC9QBIExIrMBS7qi0zk-Y,4483
+musica/mechanism_configuration/emission.py,sha256=ak45GY1NswB3P4BwDxRwIky73krz2vxds9t_rP8PxMI,3013
+musica/mechanism_configuration/first_order_loss.py,sha256=Ign87rhDSOiIWV0fSKhHBP1dNvjwBVoXkZ8_H17pE8g,3115
+musica/mechanism_configuration/henrys_law.py,sha256=tbyKP0p_wI7KzmQHaBnjIbdeObu9LzG9fwMDxJBgWZA,4266
+musica/mechanism_configuration/mechanism_configuration.py,sha256=pfDOUxZyyYNYrBzl-Lg_CoWtvQ4Dst5NMubalFVpkdY,7028
+musica/mechanism_configuration/phase.py,sha256=fN8sicZTRVAcFE4djXaj5Pu_pnb-cjA-BymSx38R16Y,1582
+musica/mechanism_configuration/photolysis.py,sha256=nh_0VXWeIqaBugox-anTbbVpqKikKrLQZzhLmaJJk_A,3827
+musica/mechanism_configuration/reactions.py,sha256=jLGo1ZfD_k3EVRBjIvn6LNGZ-oELLittgAB1tdDB0po,1735
+musica/mechanism_configuration/simpol_phase_transfer.py,sha256=AkKgMyCnLmF3n4ueLi470me8jj2Khd0bOuqj7bbJG68,4335
+musica/mechanism_configuration/species.py,sha256=-Rzfyg5Kg5DzLVoAF5exxAuygilvp2HILu-1iZJFXXM,3995
+musica/mechanism_configuration/surface.py,sha256=nYMdIPtgo3XwPG4zht-BNEY7MOf5rWQ15GMpH0HUo0E,4274
+musica/mechanism_configuration/troe.py,sha256=mtVAJcjF9jX3_3q8Z8rG47DvOIrEMB2e6BtSDImOJQA,6713
+musica/mechanism_configuration/tunneling.py,sha256=KVJD7Ej7PecdP0Q4orm8PzMQtgFyHJhSQnFh17qjmgo,4408
+musica/mechanism_configuration/user_defined.py,sha256=7p7xGbAous_3Ef2qfNnc8d63g0G86GpPOGl-GmGRvrs,3835
+musica/mechanism_configuration/utils.py,sha256=dhMFrydNchhdRrfeJw35oJB8Y5oQJa6p65Z7I127P-8,356
+musica/mechanism_configuration/wet_deposition.py,sha256=_9xKNyHFZpfKPBbpi0L_Hi2dilBZIPAMw1rXY2VmUcs,2232
+musica/mechanism_configuration.cpp,sha256=OI1Ua3xypbSe7dPfL50J9qCyHY1b809bRv1DdXu31Iw,27552
+musica/musica.cpp,sha256=w6kI-mrUqNbJPeYuuPzzsDrb7GsHy2bKNoOt0b8tJTY,8614
+musica/test/examples/v0/config.json,sha256=JDQdrDNRmRXGYlytX1uiSDV1lkYIAneLwlodHKFw-os,85
+musica/test/examples/v0/config.yaml,sha256=r31QbiFE2YDudGxLGpTKnpyveTnlfXeLgJ2qSrQddDY,47
+musica/test/examples/v0/reactions.json,sha256=SmRUE5XOAv0h3HOWg4Fb1swBiZvZ-1hsIrmMCJqEVIk,4380
+musica/test/examples/v0/reactions.yaml,sha256=5QeEkhjeAL_rXxNYCLOuqDUudTmgwLW3NERDupKpj6s,2408
+musica/test/examples/v0/species.json,sha256=klFuYb2vAtWdHfHJVYuIuPe_6LHRTuB0Aw29YhwfCFc,604
+musica/test/examples/v0/species.yaml,sha256=ECT9DDa2GMwhSRaRLxjOiCATTKkTRTPwugRsUjHSytY,302
+musica/test/examples/v1/full_configuration/full_configuration.json,sha256=QgCno36VZANP1FcH25ogeYuBtnesdFcc7Mj6CztK4Ds,9660
+musica/test/examples/v1/full_configuration/full_configuration.yaml,sha256=I-eMC2jSCRQ8AvV2WQeF2y96A6ouNDLrvPjvRZV-AXc,5820
+musica/test/test_analytical.py,sha256=domkY4O00RplSdnFvssqUGtPyoXQiV0cfRaLH3gsQ2c,14131
+musica/test/test_chapman.py,sha256=t6p0CadUy-B4OP7A-EZ9Wz52diuYs5yc9LKiFUS9T6A,3651
+musica/test/test_parser.py,sha256=1lL2DZ7ZT1IBGKG3aAc1P_z5GW3u8oBgP6vn3tGr150,2316
+musica/test/test_serializer.py,sha256=mVOXgUFiN5OmCK-8ramsd4hLAYjgvunqBElRbs6nzyM,2535
+musica/test/test_util_full_mechanism.py,sha256=pDWZhJWdP1Q8iCab9AV7GMNIlNdMdgNuAJRqqRccDuw,24730
+musica/test/tuvx.py,sha256=L8X7rJ09HiRlrhLK6fjircI8tGHnFCZJzVow8He5YOE,126
+musica/tools/prepare_build_environment_linux.sh,sha256=kdcBj9qELh811OzY8o5tQDAnLXJFXqzwIkZmkRAcLFY,1500
+musica/tools/prepare_build_environment_windows.sh,sha256=sBBWhJQaS2zWDVFLIDMNBMOMPw8auXwnwz7nhuB5Q_k,847
+musica/tools/repair_wheel_gpu.sh,sha256=nQueyGNC2qWcBAicjVdAfB6JH4m_51dFOG83vVxke54,1525
+musica/types.py,sha256=aBDIOOF9I3u7_drTJebln0O88z0z9dfRNGWhAhP8_7o,15148
+musica-0.12.0.dist-info/METADATA,sha256=ecoVy_lRUnvTA_JTGQRg8SB3EtlnFMr2Lq_8Ke8X1gs,25995
+musica-0.12.0.dist-info/WHEEL,sha256=Twt6k6Iq5MLawLlqt_rmxVYgadRzJ6CAnLOmGD9IUZc,102
+musica-0.12.0.dist-info/licenses/AUTHORS.md,sha256=1ssAXR4WOMdfl5Or1raPu_2nxHbkwCpxfwJwzpF_cJM,2691
+musica-0.12.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+musica-0.12.0.dist-info/RECORD,,

musica-0.12.0.dist-info/licenses/AUTHORS.md

@@ -0,0 +1,59 @@
+# MUSICA Authors and Contributors
+
+This file acknowledges all individuals who have contributed to the MUSICA project.
+
+## Core Development Team
+
+The following individuals are the primary developers and maintainers of the MUSICA software:
+
+- **Matthew Dawson** (mattdawson@ucar.edu) - Core Developer
+- **Jiwon Gim** (jiwongim@ucar.edu) - Core Developer  
+- **David Fillmore** (fillmore@ucar.edu) - Core Developer
+- **Kyle Shores** (kshores@ucar.edu) - Core Developer
+- **Montek Thind** (mthind@ucar.edu) - Core Developer
+- **Jian Sun** - Core Developer
+
+## Scientific Leadership and Vision
+
+The scientific leadership and vision for MUSICA are provided by the authors of the [foundational paper](https://doi.org/10.1175/BAMS-D-19-0331.1). 
+This software implements that vision. For a full list of scientific authors, 
+please refer to our [CITATION.cff](CITATION.cff) file. To cite the software, use the Zenodo DOI from our latest release.
+
+## Additional Contributors
+
+<!-- Contributors will be added here as they join the project -->
+<!-- Format: -->
+<!-- - **Name** (affiliation) - Brief description of contribution -->
+
+- **Aidan Winney** - Documentation and Tutorials
+- **Angela Pak** - Documentation and Tutorials
+- **Dee Grant** - Improving the Python API
+- **Qina Tan** - Implementing the CUDA-based Rosenbrock solver
+
+## Recognition Policy
+
+We recognize contributors at different levels based on their involvement:
+
+- **Core Development Team**: Listed in `pyproject.toml`, `.zenodo.json` (creators), and this file
+- **Additional Contributors**: Listed in `.zenodo.json` (contributors) and this file
+- **All Contributors**: Automatically tracked by GitHub's contributor statistics
+
+See our [Contributing Guide](CONTRIBUTING.md) for more details on how contributions are recognized.
+
+## How to Contribute
+
+We welcome contributions from the community! Please see our [Contributing Guide](CONTRIBUTING.md) for information on how to get involved.
+
+## Acknowledgments
+
+We thank the broader atmospheric chemistry modeling community for their feedback, testing, and contributions to making MUSICA a robust and useful tool for scientific research.
+
+---
+
+## Citation Information
+
+For citation purposes, please refer to our [CITATION.cff](CITATION.cff) file for the appropriate citations based on your use case. The main citations are:
+
+1. **For the MUSICA vision and scientific framework**: [Pfister et al., 2020](https://doi.org/10.1175/BAMS-D-19-0331.1)
+2. **For the MUSICA software evaluation**: [Schwantes et al., 2022](https://doi.org/10.1029/2021MS002889)
+3. **For the software itself**: Use the Zenodo DOI from our latest release