Skip to main content

ML4PD - an open-source libray for building Aspen-like process models via machine learning.

Project description

ml4pd

Process design with Machine Learning.

How to Install for Users

pip install ml4pd git+https://github.com/NREL/ml4pd_models.git@v1

How to Set Up for Development

git clone https://github.com/NREL/ml4pd.git
git clone https://github.com/NREL/ml4pd_models.git
mamba env create -f ml4pd/environment.yml
conda develop ml4pd
conda develop ml4pd_models

Additional GitHub repositories for docs, tests and training

  • ml4pd_utils: code base for generating & preparing data for training.
  • autoaspen: database for data obtained by aspen & python.

To debug docs

  • Use mkdocs serve within ml4pd directory, then go to localhost:8000.
  • generate_site.py gets docstrings (written in makrdown) from classes and put them in the right directory.
  • To make changes to notebooks, add ml4pd to path with sys.path.append() or conda develop.

Relationship with ml4pd_models

To minimize manual work, ml4pd dependends on a specific ml4pd_models github branch. When changes are made to either ml4pd or ml4pd_models that will break compatibility, create new branch in ml4pd_models, and apply change to workflow .yml files, this README and index.md in docs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ml4pd-2022.11.9.tar.gz (24.0 kB view hashes)

Uploaded source

Built Distribution

ml4pd-2022.11.9-py3-none-any.whl (29.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page