|
2 | 2 | **Solvent Crossflow Heat Exchanger Calculator:** |
3 | 3 | A Process model in Aspen Plus to optimize the size of the heat exchangers and their log-mean temperature difference (LMTD) to minimize capital and operating expenses. |
4 | 4 |
|
5 | | -## Development Practices |
6 | | - |
7 | | -* Code development will be peformed in a forked copy of the repo. Commits will not be |
8 | | - made directly to the repo. Developers will submit a pull request that is then merged |
9 | | - by another team member, if another team member is available. |
10 | | -* Each pull request should contain only related modifications to a feature or bug fix. |
11 | | -* Sensitive information (secret keys, usernames etc) and configuration data |
12 | | - (e.g database host port) should not be checked in to the repo. |
13 | | -* A practice of rebasing with the main repo should be used rather that merge commmits. |
| 5 | +Note: This product is also part of the [Process Models Bundle](../../../ProcessModels_bundle) |
14 | 6 |
|
15 | 7 | ## Getting Started |
16 | 8 |
|
17 | | -TBD |
| 9 | +See installation and user guide documents in the [documentation](./docs) subdirectory. |
18 | 10 |
|
19 | 11 | ## Authors |
20 | 12 |
|
21 | 13 | * Brent Sherman |
22 | 14 |
|
23 | | -See also the list of [contributors](https://github.com/CCSI-Toolset/SolventCrossflowHX/contributors) who participated in this project. |
| 15 | +See also the list of [contributors](../../contributors) who participated in this project. |
| 16 | + |
| 17 | +## Development Practices |
| 18 | + |
| 19 | +* Code development will be performed in a forked copy of the repo. Commits will not be |
| 20 | + made directly to the repo. Developers will submit a pull request that is then merged |
| 21 | + by another team member, if another team member is available. |
| 22 | +* Each pull request should contain only related modifications to a feature or bug fix. |
| 23 | +* Sensitive information (secret keys, usernames etc.) and configuration data |
| 24 | + (e.g. database host port) should not be checked in to the repo. |
| 25 | +* A practice of rebasing with the main repo should be used rather than merge commits. |
24 | 26 |
|
25 | 27 | ## Versioning |
26 | 28 |
|
27 | 29 | We use [SemVer](http://semver.org/) for versioning. For the versions available, |
28 | | -see the [tags on this repository](https://github.com/CCSI-Toolset/SolventCrossflowHX/tags). |
| 30 | +see the [releases](../../releases) or [tags](../../tags) for this repository. |
29 | 31 |
|
30 | 32 | ## License & Copyright |
31 | 33 |
|
|
0 commit comments