Skip to content

Commit

Permalink
Deploy to GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] authored Mar 2, 2024
1 parent de79c0c commit 387e8c1
Show file tree
Hide file tree
Showing 7 changed files with 682 additions and 142 deletions.
Binary file modified latest/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified latest/.doctrees/installation.doctree
View file
Binary file not shown.
Binary file added latest/.doctrees/knownissues.doctree
View file
Binary file not shown.
165 changes: 24 additions & 141 deletions latest/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -590,148 +590,39 @@

<section id="installation">
<span id="id1"></span><h1>Installation</h1>
<section id="install-with-conda-and-pip-recommended">
<h2>Install with conda and pip (recommended)</h2>
<p>Create an <code class="docutils literal notranslate"><span class="pre">conda</span></code> environment <code class="docutils literal notranslate"><span class="pre">cra</span></code>.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span>cra<span class="w"> </span><span class="nv">python</span><span class="o">=</span><span class="m">3</span>.8
<section id="stable">
<h2>Stable</h2>
<p>Stable releases can be installed using a combination of conda and pip.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span>cra<span class="w"> </span><span class="nv">python</span><span class="o">=</span><span class="m">3</span>.9<span class="w"> </span><span class="nv">pyomo</span><span class="o">=</span><span class="m">6</span>.4.2<span class="w"> </span>ipopt<span class="w"> </span>compas
</pre></div>
</div>
<p>Activate the environment.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>activate<span class="w"> </span>cra
</pre></div>
</div>
<p>Install <code class="docutils literal notranslate"><span class="pre">compas_cra</span></code> with <code class="docutils literal notranslate"><span class="pre">pip</span></code>.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>compas_cra
</pre></div>
</div>
<p>Install <a class="reference external" href="https://coin-or.github.io/Ipopt/">IPOPT</a> solver.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>install<span class="w"> </span>ipopt<span class="w"> </span><span class="c1"># For Windows: conda install ipopt=3.11.1</span>
</pre></div>
</div>
<p>Install <a class="reference external" href="https://compas.dev/compas_view2/">compas_view2</a> for visualisation.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span><span class="nv">compas_view2</span><span class="o">=</span><span class="m">0</span>.7.0
</pre></div>
</div>
<p>Verify that the installation was successful.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>compas_cra
</pre></div>
</div>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Yay!<span class="w"> </span>COMPAS<span class="w"> </span>CRA<span class="w"> </span>is<span class="w"> </span>installed<span class="w"> </span>correctly!
</pre></div>
</div>
<p>Try the <a class="reference internal" href="tutorial.html#tutorial"><span class="std std-ref">Tutorial</span></a> script.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>scripts/tutorial_cubes.py
</pre></div>
</div>
</section>
<section id="developer-guide">
<h2>Developer Guide</h2>
<p>You can also install COMPAS CRA manually from <a class="reference external" href="https://github.com/BlockResearchGroup/compas_cra">source</a>.</p>
<section id="install-from-source">
<h3>Install from source</h3>
<p>Create a virtual environment using your tool of choice (e.g. virtualenv, conda, etc), optional.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span>cra
conda<span class="w"> </span>activate<span class="w"> </span>cra
</pre></div>
</div>
<p>Go to your directory and clone <code class="xref py py-mod docutils literal notranslate"><span class="pre">compas_cra</span></code>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>git@github.com:BlockResearchGroup/compas_cra.git
<span class="nb">cd</span><span class="w"> </span>compas_cra
</pre></div>
</div>
<p>Install requirements</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-dev.txt
</pre></div>
</div>
<p>In the <a class="reference external" href="https://github.com/BlockResearchGroup/compas_cra/blob/main/requirements-dev.txt">requirements-dev.txt</a>, we also installed COMPAS CRA as an editable version from local source.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>On Windows, you should install <code class="docutils literal notranslate"><span class="pre">ipopt=3.11.1</span></code>.</p>
</div>
<p>Install <a class="reference external" href="https://coin-or.github.io/Ipopt/">IPOPT</a> solver.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>install<span class="w"> </span>ipopt<span class="w"> </span><span class="c1"># For Windows: conda install ipopt=3.11.1</span>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>activate<span class="w"> </span>cra
pip<span class="w"> </span>install<span class="w"> </span>compas_cra
</pre></div>
</div>
<p>Install <a class="reference external" href="https://compas.dev/compas_view2/">compas_view2</a> for visualisation.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span><span class="nv">compas_view2</span><span class="o">=</span><span class="m">0</span>.7.0
<p>To use the CRA viewer, you should also install <code class="xref py py-mod docutils literal notranslate"><span class="pre">compas_view2</span></code>
and the COMPAS 2 migration from the compatibility branch of the github repo.
(we will replace this by <code class="xref py py-mod docutils literal notranslate"><span class="pre">compas_viewer</span></code> soon).</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>install<span class="w"> </span>matplotlib<span class="w"> </span>compas_view2
pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/compas-dev/compas_view2.git@compas2
</pre></div>
</div>
</section>
<section id="a-quicker-way-from-yml-file">
<h3>A quicker way - from <cite>.yml</cite> file</h3>
<p>Set up conda channels</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>config<span class="w"> </span>--add<span class="w"> </span>channels<span class="w"> </span>conda-forge
</pre></div>
</div>
<p>Clone <code class="xref py py-mod docutils literal notranslate"><span class="pre">compas_cra</span></code>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>git@github.com:BlockResearchGroup/compas_cra.git
<section id="latest">
<h2>Latest</h2>
<p>The latest version can be installed from local source using an environment file.
Please use the correct environment file for your system
(<code class="docutils literal notranslate"><span class="pre">env_linux.yml</span></code>, <code class="docutils literal notranslate"><span class="pre">env_osx.yml</span></code>, <code class="docutils literal notranslate"><span class="pre">env_win.yml</span></code>)</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/blockresearchgroup/compas_cra.git
<span class="nb">cd</span><span class="w"> </span>compas_cra
conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-f<span class="w"> </span>env_osx.yml
</pre></div>
</div>
<p>Install COMPAS CRA with all dependencies in a new conda environment:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-f<span class="w"> </span>env_osx.yml<span class="w"> </span><span class="c1"># (Mac)</span>
conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-f<span class="w"> </span>env_win.yml<span class="w"> </span><span class="c1"># (Windows)</span>
conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-f<span class="w"> </span>env_linux.yml<span class="w"> </span><span class="c1"># (Linux)</span>

conda<span class="w"> </span>activate<span class="w"> </span>cra<span class="w"> </span><span class="c1"># you can change the environment name in .yml file</span>
</pre></div>
</div>
</section>
<section id="update-conda-packages">
<h3>Update conda packages</h3>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>env<span class="w"> </span>update<span class="w"> </span>cra<span class="w"> </span>--file<span class="w"> </span>env_osx.yml<span class="w"> </span>--prune<span class="w"> </span><span class="c1"># (Mac)</span>
conda<span class="w"> </span>env<span class="w"> </span>update<span class="w"> </span>cra<span class="w"> </span>--file<span class="w"> </span>env_win.yml<span class="w"> </span>--prune<span class="w"> </span><span class="c1"># (Windows)</span>
conda<span class="w"> </span>env<span class="w"> </span>update<span class="w"> </span>cra<span class="w"> </span>--file<span class="w"> </span>env_linux.yml<span class="w"> </span>--prune<span class="w"> </span><span class="c1"># (Linux)</span>
</pre></div>
</div>
</section>
<section id="verify-installation">
<h3>Verify installation</h3>
<p>After running:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>invoke<span class="w"> </span><span class="nb">test</span>
</pre></div>
</div>
<p>You should see something like:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">=============================</span><span class="w"> </span><span class="nb">test</span><span class="w"> </span>session<span class="w"> </span><span class="nv">starts</span><span class="w"> </span><span class="o">==============================</span>
platform<span class="w"> </span>darwin<span class="w"> </span>--<span class="w"> </span>Python<span class="w"> </span><span class="m">3</span>.8.13,<span class="w"> </span>pytest-7.0.1,<span class="w"> </span>pluggy-1.0.0
rootdir:<span class="w"> </span>~/compas-dev/compas_cra,<span class="w"> </span>configfile:<span class="w"> </span>setup.cfg,<span class="w"> </span>testpaths:<span class="w"> </span>tests
collected<span class="w"> </span><span class="m">4</span><span class="w"> </span>items

tests/test_cra.py<span class="w"> </span>.<span class="w"> </span><span class="o">[</span><span class="w"> </span><span class="m">25</span>%<span class="o">]</span>
tests/test_cra_penalty.py<span class="w"> </span>.<span class="w"> </span><span class="o">[</span><span class="w"> </span><span class="m">50</span>%<span class="o">]</span>
tests/test_ipopt.py<span class="w"> </span>.<span class="w"> </span><span class="o">[</span><span class="w"> </span><span class="m">75</span>%<span class="o">]</span>
tests/test_rbe.py<span class="w"> </span>.<span class="w"> </span><span class="o">[</span><span class="m">100</span>%<span class="o">]</span>

<span class="o">===============================</span><span class="w"> </span>warnings<span class="w"> </span><span class="nv">summary</span><span class="w"> </span><span class="o">===============================</span>
.
.
.
--<span class="w"> </span>Docs:<span class="w"> </span>https://docs.pytest.org/en/stable/how-to/capture-warnings.html
<span class="o">========================</span><span class="w"> </span><span class="m">4</span><span class="w"> </span>passed,<span class="w"> </span><span class="m">5</span><span class="w"> </span>warnings<span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="m">2</span>.41s<span class="w"> </span><span class="o">=========================</span>
</pre></div>
</div>
</section>
</section>
<section id="rhino-installation">
<h2>Rhino Installation</h2>
<p><code class="xref py py-mod docutils literal notranslate"><span class="pre">compas_cra</span></code> is developed independent of the functionality of CAD software.
However, CAD software can be useful to create geometrical objects.
For a more detailed information on how to install COMPAS and its packages for Rhino,
please refer to <a class="reference external" href="https://compas.dev/compas/latest/gettingstarted/rhino.html">Working in Rhino</a> page of the COMPAS documentation.</p>
<p>In order to install COMPAS CRA for Rhino, do</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python -m compas_rhino.uninstall
$ python -m compas_rhino.install
$ python -m compas_rhino.install -p compas_cra
</pre></div>
</div>
<p>Every time a new file is opened in Rhino, be sure to restart Rhino or reset the Python Script Engine before running scripts.</p>
</section>
<section id="known-issues-windows">
<h2>Known issues (Windows)</h2>
<ul class="simple">
<li><p>pyomo cannot find ipopt location: <code class="docutils literal notranslate"><span class="pre">pyomo.common.errors.ApplicationError:</span> <span class="pre">No</span> <span class="pre">executable</span> <span class="pre">found</span> <span class="pre">for</span> <span class="pre">solver</span> <span class="pre">'ipopt'</span></code>. Please refer this thread for solution: <a class="reference external" href="https://groups.google.com/g/open-dsopf/c/wYPbZp-HLCw?pli=1">https://groups.google.com/g/open-dsopf/c/wYPbZp-HLCw?pli=1</a></p></li>
<li><p><code class="xref py py-mod docutils literal notranslate"><span class="pre">compas_cra</span></code> uses <a class="reference external" href="https://coin-or.github.io/Ipopt/">IPOPT</a> solver, so it might not work for PC with AMD processor.</p></li>
</ul>
<p>Note that this will automatically create an editable install that can be used for development.</p>
</section>
</section>

Expand All @@ -756,16 +647,8 @@ <h2>Known issues (Windows)</h2>
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#install-with-conda-and-pip-recommended">Install with conda and pip (recommended)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#developer-guide">Developer Guide</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#install-from-source">Install from source</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#a-quicker-way-from-yml-file">A quicker way - from <cite>.yml</cite> file</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#update-conda-packages">Update conda packages</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#verify-installation">Verify installation</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rhino-installation">Rhino Installation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#known-issues-windows">Known issues (Windows)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#stable">Stable</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#latest">Latest</a></li>
</ul>
</nav></div>

Expand Down
Loading

0 comments on commit 387e8c1

Please sign in to comment.