diff --git a/README.md b/README.md index 4c3bdfa..bf2c102 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,16 @@ -# WWC -**WWC: OpenFOAM Wetted Wall Simulation Package** +# WWC: OpenFOAM Wetted Wall Simulation Package A CFD model developed to simulate the hydrodynamics of falling film in wetted wall column, coupled with mass transfer and absorption of gas species. -## Development Practices +## Getting Started +See installation and user guide documents in the [docs](docs) subdirectory. + +## Authors +* Chao Wang +* Zhijie (Jay) Xu + +See also the list of [contributors](../../contributors) who participated in this project. +## 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. @@ -12,22 +19,9 @@ A CFD model developed to simulate the hydrodynamics of falling film in wetted wa (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. -## Getting Started - -TBD - -## Authors - -* Chao Wang -* Zhijie (Jay) Xu - -See also the list of [contributors](https://github.com/CCSI-Toolset/WWC/contributors) who participated in this project. - ## Versioning - We use [SemVer](http://semver.org/) for versioning. For the versions available, -see the [tags on this repository](https://github.com/WWC/tags). +[releases](../../releases) or [tags](../..//tags) on this repository. ## License & Copyright - See [LICENSE.md](LICENSE.md) file for details diff --git a/docs/CCSI WWC User Manual.docx b/docs/CCSI WWC User Manual.docx new file mode 100644 index 0000000..e4bb5bd Binary files /dev/null and b/docs/CCSI WWC User Manual.docx differ diff --git a/docs/CCSI WWC User Manual.pdf b/docs/CCSI WWC User Manual.pdf new file mode 100644 index 0000000..e1f9281 Binary files /dev/null and b/docs/CCSI WWC User Manual.pdf differ diff --git a/jenkins_description.html b/jenkins_description.html deleted file mode 100644 index 141f205..0000000 --- a/jenkins_description.html +++ /dev/null @@ -1,19 +0,0 @@ -WWC: OpenFOAM Wetted Wall Simulation Package
-A CFD model developed to simulate the hydrodynamics of falling film in wetted wall column, coupled with mass transfer and absorption of gas species.
-
- - - - - - - - - - - - - -
Product Team:PT2
Developers:Chao Wang, - Zhijie (Jay) Xu -
Drupal:WWC
Jira:WWC