Skip to content

Commit

Permalink
correct typos in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MialLewis committed Dec 21, 2023
1 parent 183c5f0 commit c18608d
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,33 @@
# VESUIVO REPOSITORY

This repository contains:
- `mvesuvio` package containing the Optimized NCP analysis proceedures, published nightly.
- `mvesuvio` package containing the Optimized NCP analysis procedures, published nightly.
- Vesuvio calibration script

## mvesuvio package

### Install mamba

To use the mvesuvio package you will need to use the `conda` or `mamba` (a faster implemenation of `conda`) package manager.
To use the `mvesuvio` package you will need to use the `conda` package manager (or preferably `mamba`, a much faster implementation of `conda`).

This is also the recommended best practice way of using the mantid packages.

To download and install mamba:
- https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html

### Create and activate an envionment
### Create and activate an environment

To create a conda environment for `mvesuvio`:
- `mamba env create -n <environment_name> -c mantid/label/nightly mvesuvio`

To activate the conda environment:
- `conda activate <environment_name>`

### Use mvesuvio via the command line
### Using mvesuvio via the command line

You can use `mvesuvio` via the command line. There are two commands available, `config` and `run`.
You can use `mvesuvio` via the command line. There are two commands available: `config` and `run`.

#### config

The `config` command has three optional arguments:
- `--set-cache` - Sets the location `mvesuvio` will set up the experiment directory.
Expand All @@ -36,14 +40,16 @@ Usage examples:
- `mvesuvio config --set-cache C:\Vesuvio --set-experiment example1 --set-ipfolder C:\IPFolder` - Set cache and IP folder, create a new experiment directory called `example1`.
- `mvesuvio config --set-experiment example2` - Creates a new experiment directory in `C:\Vesuvio` called `example2`.

#### run

The `run` command has one optional argument:
- `--yes` - If provided, this argument automatically inputs `Y` when prompted for user input.

Usage example:
- `mvesuvio run --yes` - Run the vesuvio analysis, automatically providing `Y` when prompted.
- `mvesuvio run`- Run the vesuvio analysis, will wait for user input when prompted.

### Use mvesuvio via workbench
### Using mvesuvio via workbench

You can also use `mvesuvio` via `mantidworkbench` if you desire a higher degree of interaction with the output workspaces.

Expand All @@ -57,9 +63,9 @@ In the workbench script editor you must first import mvesuvio:

- `import mvesuvio as mv`

After this you can set the config if desered, as above in the command line example. All arguments are optional.
After this you can set the config if desired, as above in the command line example. All arguments are optional.

- `mv.set_config(cache_directory='C:\Vesuvio', experiment_id='example3', set_ip_folder_directory='C:\IPFolder')`
- `mv.set_config(cache_directory='C:\Vesuvio', experiment_id='example3', ip_folder='C:\IPFolder')`

Following the setting of the config, you can use workbench to open and edit the analysis input file created in the relevant experiment directory.
Once the inputs have been ammended and the file saved, run the analysis:
Expand Down

0 comments on commit c18608d

Please sign in to comment.