Skip to content

Commit 45c5f98

Browse files
committed
update
1 parent dc52f84 commit 45c5f98

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ NeqSim Python is part of the [NeqSim project](https://equinor.github.io/neqsimho
1212
NeqSim Python is distributed as a pip package. Please read the [Prerequisites](#prerequisites).
1313

1414
End-users should install neqsim python with some additional packages by running
15+
1516
```
1617
pip install neqsim
1718
```
@@ -95,7 +96,7 @@ print(f"Compressor power: {process.get('compressor').getPower()/1e6:.2f} MW")
9596

9697
### 4. Direct Java Access (Full control)
9798

98-
Explicit process management using jneqsim - for advanced features:
99+
Explicit process management using jneqsim - for advanced features see [neqsim java API](https://github.com/equinor/neqsim):
99100

100101
```python
101102
from neqsim import jneqsim
@@ -125,27 +126,25 @@ print(f"Compressor power: {comp.getPower()/1e6:.2f} MW")
125126

126127
### Choosing an Approach
127128

128-
| Use Case | Recommended Approach |
129-
|----------|---------------------|
130-
| Learning & prototyping | Python wrappers |
131-
| Jupyter notebooks | Python wrappers |
132-
| Production applications | ProcessContext |
133-
| Multiple parallel processes | ProcessContext |
134-
| Configuration-driven design | ProcessBuilder |
135-
| Advanced Java features | Direct Java access |
129+
| Use Case | Recommended Approach |
130+
| --------------------------- | -------------------- |
131+
| Learning & prototyping | Python wrappers |
132+
| Jupyter notebooks | Python wrappers |
133+
| Production applications | ProcessContext |
134+
| Multiple parallel processes | ProcessContext |
135+
| Configuration-driven design | ProcessBuilder |
136+
| Advanced Java features | Direct Java access |
136137

137138
See the [examples folder](https://github.com/equinor/neqsim-python/tree/master/examples) for more process simulation examples, including [processApproaches.py](https://github.com/equinor/neqsim-python/blob/master/examples/processApproaches.py) which demonstrates all four approaches.
138139

139140
### Prerequisites
140141

141142
Java version 8 or higher ([Java JDK](https://adoptium.net/)) needs to be installed. The Python package [JPype](https://github.com/jpype-project/jpype) is used to connect Python and Java. Read the [installation requirements for Jpype](https://jpype.readthedocs.io/en/latest/install.html). Be aware that mixing 64 bit Python with 32 bit Java and vice versa crashes on import of the jpype module. The needed Python packages are listed in the [NeqSim Python dependencies page](https://github.com/equinor/neqsim-python/network/dependencies).
142143

143-
144144
## Contributing
145145

146146
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
147147

148-
149148
## Discussion forum
150149

151150
Questions related to neqsim can be posted in the [github discussion pages](https://github.com/equinor/neqsim/discussions).

0 commit comments

Comments
 (0)