Skip to content
Snippets Groups Projects
Commit a30f1ccb authored by Sylvester Joosten's avatar Sylvester Joosten
Browse files

renamed deploy-->install to avoid confusion

parent 0d65f8b6
No related branches found
No related tags found
1 merge request!18Re-factor repository workflow
This commit is part of merge request !18. Comments created here will be created in the context of that merge request.
...@@ -10,14 +10,14 @@ git clone https://eicweb.phy.anl.gov/containers/eic_container.git ...@@ -10,14 +10,14 @@ git clone https://eicweb.phy.anl.gov/containers/eic_container.git
cd eic_container cd eic_container
``` ```
2. Run the deploy script `deploy.py` to install to your `<PREFIX>` of choice 2. Run the install script `install.py` to install to your `<PREFIX>` of choice
(e.g. $HOME/local/opt/eic_container_1.0.4). By default the (e.g. $HOME/local/opt/eic_container_1.0.4). By default the
modeuefile will be installed to `$PREFIX/../../etc/modulefiles`. modeuefile will be installed to `$PREFIX/../../etc/modulefiles`.
You can use the `-v` flag to select the version you want to deploy, or omit the You can use the `-v` flag to select the version you want to install, or omit the
flag if you want to install the master build. The recommended stable flag if you want to install the master build. The recommended stable
release version is `v2.5.0`. release version is `v2.5.0`.
```bash ```bash
./deploy.py -v 2.5.0 <PREFIX> ./install.py -v 2.5.0 <PREFIX>
``` ```
Available flags: Available flags:
...@@ -29,7 +29,7 @@ cd eic_container ...@@ -29,7 +29,7 @@ cd eic_container
-m MODULE_PATH, --module-path MODULE_PATH -m MODULE_PATH, --module-path MODULE_PATH
(opt.) Root module path where you want to install a (opt.) Root module path where you want to install a
modulefile. D: <prefix>/../../etc/modulefiles modulefile. D: <prefix>/../../etc/modulefiles
-l, --local Local deploy, will not install the modulefiles (you will have -l, --local Local install, will not install the modulefiles (you will have
to run the launcher scripts from their relative paths). to run the launcher scripts from their relative paths).
-f, --force Force-overwrite already downloaded container with the same name. -f, --force Force-overwrite already downloaded container with the same name.
``` ```
...@@ -41,16 +41,16 @@ cd eic_container ...@@ -41,16 +41,16 @@ cd eic_container
module load eic_container module load eic_container
``` ```
4. To use the container in local mode, you can deploy the container with the `-l` flag, 4. To use the container in local mode, you can install the container with the `-l` flag,
and then use the runscripts (under `$PREFIX/bin`) manually. and then use the runscripts (under `$PREFIX/bin`) manually.
```bash ```bash
./deploy.py $PREFIX -l ./install.py $PREFIX -l
... ...
$PREFIX/bin/eic-shell $PREFIX/bin/eic-shell
``` ```
4. (Advanced) If you need to add additional bind directives for the internal singularity container, 4. (Advanced) If you need to add additional bind directives for the internal singularity container,
you can add them with the `-b` flag. Run `./deploy.py -h` to see a list of all you can add them with the `-b` flag. Run `./install.py -h` to see a list of all
supported options. supported options.
Usage Usage
...@@ -75,9 +75,9 @@ eic-shell ...@@ -75,9 +75,9 @@ eic-shell
### B. Running the singularity development locally (without modulefiles) ### B. Running the singularity development locally (without modulefiles)
1. This is assuming you deployed with the `-l` flag to a prefix `$PREFIX`: 1. This is assuming you installed with the `-l` flag to a prefix `$PREFIX`:
```bash ```bash
./deploy.py $PREFIX ./install.py $PREFIX
``` ```
2. To start a shell in the container environment, do 2. To start a shell in the container environment, do
......
File moved
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment