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
withinml4pd
directory, then go tolocalhost: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 withsys.path.append()
orconda 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
Release history Release notifications | RSS feed
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)
Built Distribution
ml4pd-2022.11.9-py3-none-any.whl
(29.9 kB
view hashes)
Close
Hashes for ml4pd-2022.11.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f240d0ab6cf6a3977d3cfd59273970909daf528e5a6d660410ec1e07e5fc5c84 |
|
MD5 | 28424d84250b7bf4441fee874b761b52 |
|
BLAKE2b-256 | 90130002966efd3d11003ea6395decb0fa50cc7518f324d28196c0293066a150 |