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

Updating README instructions. #113

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,19 @@ asynchronously as NetCDF4, CSV or TSV.
## Prerequisites

1. Clone the repository
2. Clone all submodules (git submodule update --init)
3. Create a conda virtual environment with the necessary packages:
2. Clone all submodules (`git submodule update --init`)
3. Clone the [ooi-config](https://github.com/oceanobservatories/ooi-config/tree/master) repository (the documentation below assumes it is cloned to the same directory as the `stream-engine` repository clone)
3. Create a `conda` virtual environment with the necessary packages using the `ooi-config/anaconda_env/engine.yml` file:

```shell
conda env create -f conda_env.yml
conda env create -f ../ooi-config/anaconda_env/engine.yml
```

## Configuration

The default Stream Engine configuration can be found in config/default.py.
Overrides can be entered into config/local.py. Gunicorn-specific
configuration parameters are set in gunicorn_config.py.
The default Stream Engine configuration can be found in `config/default.py`.
Overrides can be entered into `config/local.py`. Gunicorn-specific
configuration parameters are set in `gunicorn_config.py`.

## Running

Expand All @@ -50,39 +51,39 @@ generally be avoided unless necessary.

### Running on Test Server

Our current test server is `uframe-3-test` under user `asadev`. Source the
Stream Engine conda environment `engine` and start the service. Run Stream
Engine in the logs directory as they are written to the current working directory:
To run on a test server, follow the Prerequisites steps above on that test machine. Then, source the Stream Engine conda environment `engine` and start the service with the `manage-streamng` tool. Run Stream Engine in the `logs` directory as logs are written to the current working directory:

```shell
source activate engine
cd ~/miniconda/envs/engine/stream_engine/logs
conda activate engine
cd logs
../manage-streamng start
```

## Logs

The following logs are generated in the logs folder:
The following logs are generated in the `logs` folder:

* stream_engine.error.log - General data retrieval, product creation logs
* stream_engine.access.log - Gunicorn access logs
* `stream_engine.error.log` - General data retrieval, product creation logs
* `stream_engine.access.log` - Gunicorn access logs

## Updating a Stream Engine installation to a newer release

Updating to a new release of Stream Engine is simple, just grab the update,
update your conda environment and the preload database submodule then
update your conda environment and the `preload-database` submodule then
reload Stream Engine.

```shell
git pull # or git fetch / git checkout <tag>
git submodule update
conda env update -f conda_env.yml
conda env update -f ../ooi-config/anaconda_env/engine.yml
./manage-streamng reload
```


## Creating a new Stream Engine release

__Note: this is out of date: the new procedure involves creating an updated ooi conda-forge package from the ooi-config repository.__

1. Update preload database submodule (if needed)
2. Update conda_env.yml with any desired library updates
3. Update config/default.py with the new version
Expand Down
36 changes: 0 additions & 36 deletions conda_env.yml

This file was deleted.

29 changes: 0 additions & 29 deletions requirements.txt

This file was deleted.