| Name | mater JSON |
| Version |
0.8.5
JSON |
| download |
| home_page | None |
| Summary | Multi-regional Assessment of Technologies, Energy and Resources |
| upload_time | 2025-02-12 20:35:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. |
| keywords |
ecological
energy
materials
research
scientific
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MATER
Metabolic Analysis for Transdisciplinary Ecological Research
[TOC]
## 📋 Requirements
- Python 3.12 or higher
We recommend using one virtual environment per Python project to manage dependencies and maintain isolation. You can use a package manager like [uv](https://docs.astral.sh/uv/) to help you with library dependencies and virtual environments.
## 📦 Install the Mater Package
Install the `mater` package via pip:
```bash
pip install mater
```
## ⚙️ Run a Simulation
The `mater` command line interface (CLI) makes it easy to run simulations. Ensure the required [Excel input file](https://zenodo.org/search?q=parent.id%3A12751420&f=allversions%3Atrue&l=list&p=1&s=10&sort=version) (chose a compatible version) is located in the root of your working directory.
Run the following command to start a simulation from your excel file:
```bash
mater run -i <YOUR_INPUT_FILE_NAME>
```
## 📊 Visualize Variables
Simulation results are stored locally in [Parquet](https://parquet.apache.org/docs/) (.mater) files.
### Output variables description
| **Output variable** | **Unit** | **Definition** | **Example** |
|----------------------------|-----------------------------------|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| control_flow | <object_unit>/time | Object footprint demand before trade between locations | Number of cars consumed in China (included the imported ones) |
| extraneous_flow | <object_unit>/time | Object consumption or coproduction | C02 coproduced (+ value) and coal consumed (- value) by the electricity production process of a coal power plant |
| in_use_stock | <object_unit> | Object in use stock | Number of cars in use |
| old_stock | <object_unit> | Object stock in landfill | Number of end of life cars unrecycled |
| process | <process_unit>/time | Number of process made by an object | Transportation process (km/year) made by cars |
| recycling_flow | <object_unit>/time | Quantity of recycled objects | Recycled end of life cars |
| reference_intensity_of_use | <process_unit>/<object_unit>/time | Intensity of use | Number of km per year made by a car |
| reference_stock | <object_unit> | How many objects should be in the in use stock | Installed power plant capacity to fulfill the electricity demand |
| secondary_production | <object_unit>/time | Coproduction due to recycling processes | Quantity of steel recycled (coproduce by recycling) in a year |
| self_disposal_flow | <object_unit>/time | End of life flow | Number of cars that cannot work anymore |
| traded_control_flow | <object_unit>/time | Object supply after trade between locations | Number of cars produced in China (included the exported ones) |
### User Interface
Results can be visualize in a built-in user interface. Go to the directory containing the result folder and use the following command :
```bash
mater plot -o <YOUR_RESULT_FOLDER_NAME>
```
### Accessing the Results from a Python Script
Below is an example Python script using `pandas` and `matplotlib` to plot specific simulation results. Each folder in the output directory corresponds to a variable that can be loaded with `pandas`.
```python
# Import the MATER package and matplotlib.pyplot
import matplotlib.pyplot as plt
from mater import Mater
# Create a Mater instance
model = Mater()
# Select the output directory where the run results are stored
model.set_output_dir() # Defaults to the working directory
# Set the run directory name
model.set_run_name("run0")
# Get a variable
in_use_stock = model.get("in_use_stock")
# Transform the dataframe and plot the results
in_use_stock.groupby(level=["location", "object"]).sum().T.plot()
plt.show()
```
This example demonstrates how to access and plot variables from simulation outputs. Adjust the code to fit your analysis needs.
## 🤝 Contributing
We welcome contributions to the MATER project! To get started, please refer to the [CONTRIBUTING](CONTRIBUTING.md) file for detailed guidelines.
## 📚 Online Documentation
For more information, refer to the official **[MATER documentation](https://isterre-dynamic-modeling.gricad-pages.univ-grenoble-alpes.fr/mater-project/mater/)**.
Raw data
{
"_id": null,
"home_page": null,
"name": "mater",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "ecological, energy, materials, research, scientific",
"author": null,
"author_email": "francois-verzier <francois.verzier@univ-grenoble-alpes.fr>",
"download_url": "https://files.pythonhosted.org/packages/6e/64/3cfe11fd115912a5c5e7b8067288fd8294690cd6f841704c9261fab5e651/mater-0.8.5.tar.gz",
"platform": null,
"description": "# MATER\n\nMetabolic Analysis for Transdisciplinary Ecological Research\n\n[TOC]\n\n## \ud83d\udccb Requirements\n\n- Python 3.12 or higher\n\nWe recommend using one virtual environment per Python project to manage dependencies and maintain isolation. You can use a package manager like [uv](https://docs.astral.sh/uv/) to help you with library dependencies and virtual environments.\n\n## \ud83d\udce6 Install the Mater Package\n\nInstall the `mater` package via pip:\n\n```bash\npip install mater\n```\n\n## \u2699\ufe0f Run a Simulation\n\nThe `mater` command line interface (CLI) makes it easy to run simulations. Ensure the required [Excel input file](https://zenodo.org/search?q=parent.id%3A12751420&f=allversions%3Atrue&l=list&p=1&s=10&sort=version) (chose a compatible version) is located in the root of your working directory.\n\nRun the following command to start a simulation from your excel file:\n\n```bash\nmater run -i <YOUR_INPUT_FILE_NAME>\n```\n\n## \ud83d\udcca Visualize Variables\n\nSimulation results are stored locally in [Parquet](https://parquet.apache.org/docs/) (.mater) files.\n\n### Output variables description\n\n| **Output variable** | **Unit** | **Definition** | **Example** |\n|----------------------------|-----------------------------------|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|\n| control_flow | <object_unit>/time | Object footprint demand before trade between locations | Number of cars consumed in China (included the imported ones) |\n| extraneous_flow | <object_unit>/time | Object consumption or coproduction | C02 coproduced (+ value) and coal consumed (- value) by the electricity production process of a coal power plant |\n| in_use_stock | <object_unit> | Object in use stock | Number of cars in use |\n| old_stock | <object_unit> | Object stock in landfill | Number of end of life cars unrecycled |\n| process | <process_unit>/time | Number of process made by an object | Transportation process (km/year) made by cars |\n| recycling_flow | <object_unit>/time | Quantity of recycled objects | Recycled end of life cars |\n| reference_intensity_of_use | <process_unit>/<object_unit>/time | Intensity of use | Number of km per year made by a car |\n| reference_stock | <object_unit> | How many objects should be in the in use stock | Installed power plant capacity to fulfill the electricity demand |\n| secondary_production | <object_unit>/time | Coproduction due to recycling processes | Quantity of steel recycled (coproduce by recycling) in a year |\n| self_disposal_flow | <object_unit>/time | End of life flow | Number of cars that cannot work anymore |\n| traded_control_flow | <object_unit>/time | Object supply after trade between locations | Number of cars produced in China (included the exported ones) |\n\n### User Interface\n\nResults can be visualize in a built-in user interface. Go to the directory containing the result folder and use the following command :\n\n```bash\nmater plot -o <YOUR_RESULT_FOLDER_NAME>\n```\n\n### Accessing the Results from a Python Script\n\nBelow is an example Python script using `pandas` and `matplotlib` to plot specific simulation results. Each folder in the output directory corresponds to a variable that can be loaded with `pandas`.\n\n```python\n# Import the MATER package and matplotlib.pyplot\nimport matplotlib.pyplot as plt\nfrom mater import Mater\n\n# Create a Mater instance\nmodel = Mater()\n\n# Select the output directory where the run results are stored\nmodel.set_output_dir() # Defaults to the working directory\n\n# Set the run directory name\nmodel.set_run_name(\"run0\")\n\n# Get a variable\nin_use_stock = model.get(\"in_use_stock\")\n\n# Transform the dataframe and plot the results\nin_use_stock.groupby(level=[\"location\", \"object\"]).sum().T.plot()\nplt.show()\n```\n\nThis example demonstrates how to access and plot variables from simulation outputs. Adjust the code to fit your analysis needs.\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions to the MATER project! To get started, please refer to the [CONTRIBUTING](CONTRIBUTING.md) file for detailed guidelines.\n\n## \ud83d\udcda Online Documentation\n\nFor more information, refer to the official **[MATER documentation](https://isterre-dynamic-modeling.gricad-pages.univ-grenoble-alpes.fr/mater-project/mater/)**.\n",
"bugtrack_url": null,
"license": "GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, \"this License\" refers to version 3 of the GNU Lesser General Public License, and the \"GNU GPL\" refers to version 3 of the GNU General Public License. \"The Library\" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An \"Application\" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A \"Combined Work\" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the \"Linked Version\". The \"Minimal Corresponding Source\" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The \"Corresponding Application Code\" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License \"or any later version\" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.",
"summary": "Multi-regional Assessment of Technologies, Energy and Resources",
"version": "0.8.5",
"project_urls": {
"Documentation": "https://isterre-dynamic-modeling.gricad-pages.univ-grenoble-alpes.fr/mater-project/mater/",
"repository": "https://gricad-gitlab.univ-grenoble-alpes.fr/isterre-dynamic-modeling/mater-project/mater"
},
"split_keywords": [
"ecological",
" energy",
" materials",
" research",
" scientific"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "04af2e29e8ee3073f76f105088a7a1b4394e79c3342ea61d84ef4aff75692b87",
"md5": "b238df994b4faba477043432e07e92be",
"sha256": "85ba2a37628c02ff50ae615fab132edb38271ff8785fcc49a7624f1e5251c38e"
},
"downloads": -1,
"filename": "mater-0.8.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b238df994b4faba477043432e07e92be",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 38337,
"upload_time": "2025-02-12T20:35:47",
"upload_time_iso_8601": "2025-02-12T20:35:47.559279Z",
"url": "https://files.pythonhosted.org/packages/04/af/2e29e8ee3073f76f105088a7a1b4394e79c3342ea61d84ef4aff75692b87/mater-0.8.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6e643cfe11fd115912a5c5e7b8067288fd8294690cd6f841704c9261fab5e651",
"md5": "20ccc6833b8837ea46244e95c5a8b568",
"sha256": "4ddc8f3070c21956319c3ff9778bc0f35d9f408ce6da49894830c371de979dfe"
},
"downloads": -1,
"filename": "mater-0.8.5.tar.gz",
"has_sig": false,
"md5_digest": "20ccc6833b8837ea46244e95c5a8b568",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 617607,
"upload_time": "2025-02-12T20:35:50",
"upload_time_iso_8601": "2025-02-12T20:35:50.265953Z",
"url": "https://files.pythonhosted.org/packages/6e/64/3cfe11fd115912a5c5e7b8067288fd8294690cd6f841704c9261fab5e651/mater-0.8.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-12 20:35:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mater"
}
