Skip to content

Commit 5f1093b

Browse files
committed
Deploying to gh-pages from @ d3ae576 🚀
1 parent df70a75 commit 5f1093b

File tree

3 files changed

+24
-1
lines changed

3 files changed

+24
-1
lines changed

README.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,7 @@ <h2> Contents </h2>
345345
<ul class="visible nav section-nav flex-column">
346346
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#definition">Definition</a></li>
347347
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#format">Format</a></li>
348+
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation">Installation</a></li>
348349
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#examples">Examples</a><ul class="nav section-nav flex-column">
349350
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#simple-example">Simple Example</a></li>
350351
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#quantum-espresso-workflow">Quantum Espresso Workflow</a></li>
@@ -378,6 +379,17 @@ <h2>Format<a class="headerlink" href="#format" title="Link to this heading">#</a
378379
The files are not intended to be human readable, but rather interact as a machine readable exchange format between the
379380
different workflow engines to enable interoperability.</p>
380381
</section>
382+
<section id="installation">
383+
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">#</a></h2>
384+
<p>The Python Workflow Definition can either be installed via pypi or via conda. For the <a class="reference external" href="https://pypi.org/project/python-workflow-definition/">pypi installation</a> use:</p>
385+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">python</span><span class="o">-</span><span class="n">workflow</span><span class="o">-</span><span class="n">definition</span>
386+
</pre></div>
387+
</div>
388+
<p>For the conda installation via the <a class="reference external" href="https://anaconda.org/conda-forge/python-workflow-definition">conda-forge community channel</a> use:</p>
389+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span><span class="p">::</span><span class="n">python</span><span class="o">-</span><span class="n">workflow</span><span class="o">-</span><span class="n">definition</span>
390+
</pre></div>
391+
</div>
392+
</section>
381393
<section id="examples">
382394
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">#</a></h2>
383395
<section id="simple-example">
@@ -584,6 +596,7 @@ <h3>NFDI4Ing Scientific Workflow Requirements<a class="headerlink" href="#nfdi4i
584596
<ul class="visible nav section-nav flex-column">
585597
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#definition">Definition</a></li>
586598
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#format">Format</a></li>
599+
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation">Installation</a></li>
587600
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#examples">Examples</a><ul class="nav section-nav flex-column">
588601
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#simple-example">Simple Example</a></li>
589602
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#quantum-espresso-workflow">Quantum Espresso Workflow</a></li>

_sources/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ the connections between the different Python functions and a conda environment f
1212
The files are not intended to be human readable, but rather interact as a machine readable exchange format between the
1313
different workflow engines to enable interoperability.
1414

15+
## Installation
16+
The Python Workflow Definition can either be installed via pypi or via conda. For the [pypi installation](https://pypi.org/project/python-workflow-definition/) use:
17+
```
18+
pip install python-workflow-definition
19+
```
20+
For the conda installation via the [conda-forge community channel](https://anaconda.org/conda-forge/python-workflow-definition) use:
21+
```
22+
conda install conda-forge::python-workflow-definition
23+
```
24+
1525
## Examples
1626
### Simple Example
1727
As a first example we define two Python functions which add multiple inputs:

0 commit comments

Comments
 (0)