Skip to content

Commit

Permalink
deploy: 2bd6b86
Browse files Browse the repository at this point in the history
  • Loading branch information
matamadio committed Oct 13, 2023
1 parent 41e16cf commit bf15b1b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
16 changes: 8 additions & 8 deletions _sources/docs/tool-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ In both cases, the script requires proper environment setup and input data to be
## Python environment

- Python 3 needs to be installed on your system. We suggest the latest [Anaconda](https://www.anaconda.com/download) distribution. Mamba is also encouraged.
- Create new `CCDR` environment according to your operating system: win.yml or linux.yml.
- Create new `CCDR-tools` environment according to your operating system: win.yml or linux.yml.
In Anaconda cmd prompt:
```
conda create --name CCDR --file <dir/win_env.yml>`
activate CCDR
```bash
conda create --name CCDR-tools --file <dir/win_env.yml>`
activate CCDR-tools
```

## Input data management
Expand Down Expand Up @@ -119,11 +119,11 @@ CACHE_DIR = ${DATA_DIR}/cache/
## Run Jupyter notebooks

- Be sure to activate the correct environment
```
activate CCDR
```bash
activate CCDR-tools
```
- Navigate to your working directory: `cd <Your work directory>`
```
```bash
cd C:\Dir\Workdir\
```
```{figure} images/cmd_prompt.png
Expand All @@ -133,7 +133,7 @@ CACHE_DIR = ${DATA_DIR}/cache/
Example of Anaconda cmd prompt
```
- Run the jupyter notebook.
```
```bash
jupyter notebook
```
The interface should pop up in your browser.
Expand Down
12 changes: 6 additions & 6 deletions docs/tool-setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -583,10 +583,10 @@ <h1>TOOLS SETUP<a class="headerlink" href="#tools-setup" title="Permalink to thi
<h2>Python environment<a class="headerlink" href="#python-environment" title="Permalink to this headline">#</a></h2>
<ul>
<li><p>Python 3 needs to be installed on your system. We suggest the latest <a class="reference external" href="https://www.anaconda.com/download">Anaconda</a> distribution. Mamba is also encouraged.</p></li>
<li><p>Create new <code class="docutils literal notranslate"><span class="pre">CCDR</span></code> environment according to your operating system: win.yml or linux.yml.
<li><p>Create new <code class="docutils literal notranslate"><span class="pre">CCDR-tools</span></code> environment according to your operating system: win.yml or linux.yml.
In Anaconda cmd prompt:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>conda create --name CCDR --file &lt;dir/win_env.yml&gt;`
activate CCDR
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>create<span class="w"> </span>--name<span class="w"> </span>CCDR-tools<span class="w"> </span>--file<span class="w"> </span>&lt;dir/win_env.yml&gt;<span class="sb">`</span>
activate<span class="w"> </span>CCDR-tools
</pre></div>
</div>
</li>
Expand Down Expand Up @@ -756,12 +756,12 @@ <h2>Settings<a class="headerlink" href="#settings" title="Permalink to this head
<h2>Run Jupyter notebooks<a class="headerlink" href="#run-jupyter-notebooks" title="Permalink to this headline">#</a></h2>
<ul>
<li><p>Be sure to activate the correct environment</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">activate</span> <span class="n">CCDR</span>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>activate<span class="w"> </span>CCDR-tools
</pre></div>
</div>
</li>
<li><p>Navigate to your working directory: <code class="docutils literal notranslate"><span class="pre">cd</span> <span class="pre">&lt;Your</span> <span class="pre">work</span> <span class="pre">directory&gt;</span></code></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">C</span><span class="p">:</span>\<span class="n">Dir</span>\<span class="n">Workdir</span>\
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>C:<span class="se">\D</span>ir<span class="se">\W</span>orkdir<span class="se">\</span>
</pre></div>
</div>
<figure class="align-center" id="id2">
Expand All @@ -772,7 +772,7 @@ <h2>Run Jupyter notebooks<a class="headerlink" href="#run-jupyter-notebooks" tit
</figure>
</li>
<li><p>Run the jupyter notebook.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">jupyter</span> <span class="n">notebook</span>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>jupyter<span class="w"> </span>notebook
</pre></div>
</div>
</li>
Expand Down

0 comments on commit bf15b1b

Please sign in to comment.