diff --git a/README.md b/README.md index 6ccfa61..2e9bf03 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,29 @@ # compressor - **Multi-stage Centrifugal Compressor Model** - A unified set of compressor models including steady-state design point model and dynamic model with surge detection. -## Development Practices - -* 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. +Note: This product is also part of the [Process Models Bundle](../../../ProcessModels_bundle) ## Getting Started - -TBD - +See installation and user guide documents in the [documentation](./docs) subdirectory. ## Authors - * Ben Omell * Debangsu Bhattacharyya -See also the list of [contributors](https://github.com/CCSI-Toolset/compressor/contributors) who participated in this project. +See also the list of [contributors](../../contributors) who participated in this project. -## Versioning +## Development Practices +* Code development will be performed 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. +## Versioning We use [SemVer](http://semver.org/) for versioning. For the versions available, -see the [tags on this repository](https://github.com/CCSI-Toolset/compressor/tags). +see the [releases](../../releases) or [tags](../../tags) for this repository. ## License & Copyright - See [LICENSE.md](LICENSE.md) file for details diff --git a/docs/CCSI Compressor User Manual.docx b/docs/CCSI Compressor User Manual.docx new file mode 100644 index 0000000..af51cbc Binary files /dev/null and b/docs/CCSI Compressor User Manual.docx differ diff --git a/docs/CCSI Compressor User Manual.pdf b/docs/CCSI Compressor User Manual.pdf new file mode 100644 index 0000000..91169b8 Binary files /dev/null and b/docs/CCSI Compressor User Manual.pdf differ diff --git a/jenkins_description.html b/jenkins_description.html deleted file mode 100644 index 39cf627..0000000 --- a/jenkins_description.html +++ /dev/null @@ -1,30 +0,0 @@ -Multi-stage Centrifugal Compressor Model
- -

A unified set of compressor models including steady-state design -point model and dynamic model with surge detection.

- - - - - - - - - - - - - - - - - - -
Product Team:PT5 Process
Developers: - Ben Omell & - Debangsu Bhattacharyya -
Drupal: - Compressor -
Jira: - CENTCOMP -