Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Binary file added docs/CCSI Compressor User Manual.docx
Binary file not shown.
Binary file added docs/CCSI Compressor User Manual.pdf
Binary file not shown.
30 changes: 0 additions & 30 deletions jenkins_description.html

This file was deleted.