Skip to content

Commit 4f87ebe

Browse files
Deploy to GitHub pages
1 parent f2f0ccb commit 4f87ebe

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

latest/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@
507507

508508
<section id="compas-framework">
509509
<h1>compas_framework</h1>
510-
<p class="lead">The COMPAS framework packages</p>
510+
<p class="lead"><cite>compas_framework</cite> is a “meta package” that can be used to simplify the installation of the base framework of COMPAS.</p>
511511
<section id="table-of-contents">
512512
<h2>Table of Contents</h2>
513513
<div class="toctree-wrapper compound">

latest/installation.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -536,26 +536,27 @@
536536
<h1>Installation</h1>
537537
<section id="stable">
538538
<h2>Stable</h2>
539-
<p>Stable releases are available on PyPI and can be installed with pip.</p>
539+
<p>For installation WITHOUT <cite>compas_occ</cite></p>
540540
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>compas_framework
541541
</pre></div>
542542
</div>
543-
</section>
544-
<section id="latest">
545-
<h2>Latest</h2>
546-
<p>The latest version can be installed from local source.</p>
547-
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/compas-dev/compas_framework.git
548-
<span class="nb">cd</span><span class="w"> </span>compas_tna
549-
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
543+
<p>For installation WITH <cite>compas_occ</cite></p>
544+
<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>compas-dev<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>compas_occ
545+
conda<span class="w"> </span>activate<span class="w"> </span>compas-dev
546+
pip<span class="w"> </span>install<span class="w"> </span>compas_framework
547+
</pre></div>
548+
</div>
549+
<p>In both cases, for installation with support for Jupyter notebooks</p>
550+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span><span class="s2">&quot;compas_framework[notebook]&quot;</span>
550551
</pre></div>
551552
</div>
552553
</section>
553554
<section id="development">
554555
<h2>Development</h2>
555-
<p>To install <cite>compas_framework</cite> for development, install from local source with the “dev” requirements.</p>
556+
<p>To install <cite>compas_framework</cite> for development, install from local source.</p>
556557
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/compas-dev/compas_framework.git
557-
<span class="nb">cd</span><span class="w"> </span>compas_tna
558-
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span><span class="s2">&quot;.[dev]&quot;</span>
558+
<span class="nb">cd</span><span class="w"> </span>compas_framework
559+
conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-f<span class="w"> </span>environment.yml
559560
</pre></div>
560561
</div>
561562
</section>
@@ -583,7 +584,6 @@ <h2>Development</h2>
583584
<nav class="bd-toc-nav page-toc">
584585
<ul class="visible nav section-nav flex-column">
585586
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#stable">Stable</a></li>
586-
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#latest">Latest</a></li>
587587
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#development">Development</a></li>
588588
</ul>
589589
</nav></div>

latest/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)