Skip to content

Open-source code for the Biomass Energy Potential Mapping & Analysis Tool (BEPMAT)

License

Notifications You must be signed in to change notification settings

ClimateCompatibleGrowth/BEPMAT

Repository files navigation

Biomass Energy Potential Mapping and Analysis Tool (BEPMAT)

This tool is designed to provide an estimate of the raw biomass energy potential from crop residues in any selected geography. We provide the options to obtain the biomass energy potential using different climate models ,different climate pathways and different time periods (including past and future). This tool aims to help researchers and policy makers make decisions on which crop to grow in any particular region in the future in order to obtain maximum energy from that land. For more details , we suggest you go through the attached documentation once.

Methodology Workflow

Methodology Workflow

Table of Contents

Installation

To install BEPMAT, follow these steps:

  1. Clone the repository: git clone https://github.com/your_username/BEPMAT.git
  2. Navigate to the project directory: cd BEPMAT
  3. Create a Conda environment: conda env create -f environment.yml
  4. Activate the Conda environment: conda activate bepmat
  5. Install any additional dependencies using Conda if necessary: conda install package_name

Usage

We provide a Jupyter notebook named UI.ipynb in the repository, which simplifies the usage of the tool. Additionaly, Examples.ipynb is also present to show what the tool will output. Follow these steps to utilize the tool effectively:

  1. Open the Notebook: Navigate to the UI.ipynb file in the repository and open it using Jupyter Notebook or JupyterLab. Please ensure that you have gone through the either the documentation or Functions.ipynb which would help you get a better idea of what the tool does.

  2. Execute the Notebook Cells: Run the notebook cells sequentially by clicking on each cell and pressing Shift + Enter or by using the "Run" button in the toolbar.

  3. Follow the Instructions: The notebook contains detailed instructions and code blocks to guide you through the process of using the tool. Follow the steps mentioned in the notebook to input your data, configure the analysis settings, and generate the results.

  4. View and Download the Results: Once you have executed all the necessary cells, you will see plotly graphs showcasing the results. Below them you will find the the option to download the complete xarrays as NetCDF4 files.

  5. Access and Visualise : We also provide another notebook Accessing_and_Visualising.ipynb which shows how you can access and Visualise the downloaded data with ease.

  6. Note on Processing Time: Please note that the tool's processing time may vary depending on your processor and the size of the input data. We are actively working to optimize performance and reduce processing times.

  7. Feedback and Support: If you encounter any issues or have suggestions for improvement, please don't hesitate to reach out to us. Your feedback is valuable in enhancing the tool's functionality and usability.

Contributing

We welcome contributions from the community! If you'd like to contribute to this project, please follow these steps:

  1. Fork this repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your changes to your forked repository.
  5. Submit a pull request detailing your changes.

License

This project is licensed under the MIT License - see the LICENSE file for details.


For questions or support, please contact [email protected].

About

Open-source code for the Biomass Energy Potential Mapping & Analysis Tool (BEPMAT)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published