Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use sh for all code blocks in readme #9213

Merged
merged 1 commit into from
Nov 14, 2024
Merged
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
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ Iterative Ensemble Smoother (IES).

## Installation

``` sh
```sh
$ pip install ert
$ ert --help
```

or, for the latest development version:

``` sh
```sh
$ pip install git+https://github.com/equinor/ert.git@main
$ ert --help
```
Expand All @@ -40,7 +40,7 @@ reservoir models (e.g., an ensemble of geologically-consistent models).
This will enable robust decisions about drilling schedule and well
placement, in order to achieve results of significant practical value.

```bash
```sh
pip install . "[everest]"
```

Expand Down Expand Up @@ -103,15 +103,15 @@ git submodule foreach "git lfs pull"
### Build documentation

You can build the documentation after installation by running
```bash
```sh
pip install ".[dev]"
sphinx-build -n -v -E -W ./docs/ert ./tmp/ert_docs
```
and then open the generated `./tmp/ert_docs/index.html` in a browser.

To automatically reload on changes you may use

```bash
```sh
sphinx-autobuild docs docs/_build/html
```

Expand All @@ -120,7 +120,7 @@ sphinx-autobuild docs docs/_build/html
There are a set of style requirements, which are gathered in the `pre-commit`
configuration, to have it automatically run on each commit do:

``` sh
```sh
$ pip install pre-commit
$ pre-commit install
```
Expand Down Expand Up @@ -151,10 +151,10 @@ command `ulimit -a`. In order to increase maximum number of open files, run

### Basic ert test
To test if ert itself is working, go to `test-data/ert/poly_example` and start ert by running `poly.ert` with `ert gui`
```
```sh
cd test-data/ert/poly_example
ert gui poly.ert
````
```
This opens up the ert graphical user interface.
Finally, test ert by starting and successfully running the experiment.

Expand Down
Loading