diff --git a/README.md b/README.md index 0fb3c24..2da9f89 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,32 @@ -# ProcessModels_bundle +# Process Models Bundle A suite of process models implemented in both Aspen Custom Modeler and gPROMS Model Builder, as well as models implemented within Aspen Plus and Aspen Plus Dynamics. -## Development Practices +This is a convenience bundle containing the following CCSI Toolset products: -* Code development will be peformed in a forked copy of the repo. Commits will not be - made directly to the repo. Developers will submit a pull request that is then merged - by another team member, if another team member is available. -* Each pull request should contain only related modifications to a feature or bug fix. -* Sensitive information (secret keys, usernames etc) and configuration data - (e.g database host port) should not be checked in to the repo. -* A practice of rebasing with the main repo should be used rather that merge commmits. +**Solid Sorbents** +- [Bubbling Fluidized Bed Dynamic Reduced Order](../../../bfb_drom) +- [Bubbling Fluidized Bed Reactor](../../../bfb_reactor) +- [Integrated Capture Systems Model](../../../intcap) +- [Moving Bed Reactor Model](../../../mb_reactor) -## Getting Started - -TBD +**Solvents** +- [High Viscosity Solvent Model, 2-MPZ](../../../2-mpz) +- [MEA Dynamic Model](../../../MEA_dm) +- [MEA Steady State Model](../../../MEA_ssm) +- [Solvent Crossflow Heat Exchanger Calculator](../../../SolventCrossflowHX) -## Authors +**Other Process Models** +- [Multi-stage Centrifugal Compressor Model](../../../compressor) +- [Membrane Separation Model](../../../membrane_model) -* Jim Leek +You can download the entire [bundle](../../releases/latest) or follow the above links to the individual products. -See also the list of [contributors](https://github.com/CCSI-Toolset/ProcessModels_bundle/contributors) who participated in this project. +## Getting Started +See installation and user guide documents in the [documentation](docs) subdirectory. ## Versioning - -We use [SemVer](http://semver.org/) for versioning. For the versions available, -see the [tags on this repository](https://github.com/CCSI-Toolset/ProcessModels_bundle/tags). +We use [SemVer](http://semver.org/) for versioning. For the versions available, +see the [releases](../../releases) or [tags](../../tags) on this repository. ## License & Copyright - See [LICENSE.md](LICENSE.md) file for details diff --git a/docs/CCSI Process Models User Manual.docx b/docs/CCSI Process Models User Manual.docx index f5538f0..380b3fd 100644 Binary files a/docs/CCSI Process Models User Manual.docx and b/docs/CCSI Process Models User Manual.docx differ diff --git a/docs/CCSI Process Models User Manual.pdf b/docs/CCSI Process Models User Manual.pdf index ce3fcc2..f8ca088 100644 Binary files a/docs/CCSI Process Models User Manual.pdf and b/docs/CCSI Process Models User Manual.pdf differ