Skip to content

Commit 8a59538

Browse files
committed
Merge branch 'master' of https://github.com/Statoil/neqsimmatlab
2 parents 7f35bb9 + cde2d86 commit 8a59538

File tree

3 files changed

+57
-33
lines changed

3 files changed

+57
-33
lines changed

CONTRIBUTING.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11+
build.
12+
2. Update the README.md with details of changes to the interface, this includes new environment
13+
variables, exposed ports, useful file locations and container parameters.
14+
3. Increase the version numbers in any examples files and the README.md to the new version that this
15+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
16+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
17+
do not have permission to do that, you may request the second reviewer to merge it for you.

README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# NeqSim Matlab
2+
NeqSim Python is a Python interface to the [NeqSim Java library](https://github.com/equinor/neqsim) for estimation of fluid behavior and process design for oil and gas production.
3+
4+
## Releases
5+
See [release folder](https://github.com/equinor/neqsimmatlab/releases)
6+
7+
## Getting Started
8+
See the [NeqSim Matlab Wiki](https://github.com/equinor/neqsimmatlab/wiki) for how to use NeqSim Matlab.
9+
10+
11+
### Initial setup
12+
The NeqSim Matlab package is downloaded by cloning the library to your local computer (alternatively fork it to your private reprository). The following commands are dependent on a local installation of [GIT](https://git-scm.com/).
13+
14+
```bash
15+
git clone https://github.com/equinor/neqsimmatlab.git
16+
cd neqsimmatlab
17+
```
18+
19+
## Contributing
20+
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
21+
22+
## Versioning
23+
NeqSim use [SemVer](https://semver.org/) for versioning.
24+
25+
## Licence
26+
NeqSim is distributed under the [Apache-2.0](https://github.com/equinor/neqsimsource/blob/master/LICENSE) licence.
27+
28+
## Acknowledgments
29+
A number of master and PhD students at NTNU have contributed to development of NeqSim. We greatly acknowledge their contributions.
30+
31+
32+
File System
33+
doc/ : Documentation for this library.
34+
example/ : Contains several examples of how EJML can be used to solve different problems or how neqsim can be modified for different applications.
35+
neqsim/ : Library source code
36+
lib/ : various labraries used for implementing NeqSim in Matlab
37+
ext/: external libraries used by NeqSim Matlab
38+
changelog.txt : History of what changed between each version.
39+
license.txt: license document
40+

README.txt

-33
This file was deleted.

0 commit comments

Comments
 (0)