Deploy to GitHub pages

latest/api/generated/compas_cra.datastructures.CRA_Assembly.copy.html

@@ -603,14 +603,16 @@
 <h1>CRA_Assembly.copy</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_cra.datastructures.CRA_Assembly.copy">
-<span class="sig-prename descclassname"><span class="pre">CRA_Assembly.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">CRA_Assembly.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy_guid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Make an independent copy of the data object.</p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl>
 <dt><strong>cls</strong><span class="classifier">Type[<a class="reference external" href="https://compas.dev/compas/latest/api/generated/compas.data.Data.html" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">compas.data.Data</span></code></a>], optional</span></dt><dd><p>The type of data object to return.
 Defaults to the type of the current data object.</p>
 </dd>
+<dt><strong>copy_guid</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the copy will have the same guid as the original.</p>
+</dd>
 </dl>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>

latest/api/generated/compas_cra.datastructures.CRA_Assembly.to_json.html

@@ -603,15 +603,18 @@
 <h1>CRA_Assembly.to_json</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_cra.datastructures.CRA_Assembly.to_json">
-<span class="sig-prename descclassname"><span class="pre">CRA_Assembly.</span></span><span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">CRA_Assembly.</span></span><span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Convert an object to its native data representation and save it to a JSON file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl class="simple">
 <dt><strong>filepath</strong><span class="classifier">str</span></dt><dd><p>The path to the JSON file.</p>
 </dd>
-<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the JSON file will be pretty printed.
-Defaults to False.</p>
+<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output with newlines and indentation.</p>
+</dd>
+<dt><strong>compact</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output without any whitespace.</p>
+</dd>
+<dt><strong>minimal</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, exclude the GUID from the JSON output.</p>
 </dd>
 </dl>
 </dd>

latest/api/generated/compas_cra.datastructures.CRA_Assembly.to_jsonstring.html

@@ -603,13 +603,16 @@
 <h1>CRA_Assembly.to_jsonstring</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_cra.datastructures.CRA_Assembly.to_jsonstring">
-<span class="sig-prename descclassname"><span class="pre">CRA_Assembly.</span></span><span class="sig-name descname"><span class="pre">to_jsonstring</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">CRA_Assembly.</span></span><span class="sig-name descname"><span class="pre">to_jsonstring</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Convert an object to its native data representation and save it to a JSON string.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl class="simple">
-<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the JSON string will be pretty printed.
-Defaults to False.</p>
+<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output with newlines and indentation.</p>
+</dd>
+<dt><strong>compact</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output without any whitespace.</p>
+</dd>
+<dt><strong>minimal</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, exclude the GUID from the JSON output.</p>
 </dd>
 </dl>
 </dd>

latest/installation.html

@@ -592,36 +592,38 @@
 <span id="id1"></span><h1>Installation</h1>
 <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>.10<span class="w"> </span><span class="nv">pyomo</span><span class="o">=</span><span class="m">6</span>.4.2<span class="w"> </span><span class="nv">ipopt</span><span class="o">=</span><span class="m">3</span>.14.9<span class="w"> </span>compas
-</pre></div>
-</div>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<p>On Windows, you may have to install <code class="docutils literal notranslate"><span class="pre">ipopt=3.11.1</span></code>.</p>
-</div>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>activate<span class="w"> </span>cra
+<p>Stable releases can be installed on <code class="docutils literal notranslate"><span class="pre">osx</span></code> and <code class="docutils literal notranslate"><span class="pre">linux</span></code> 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>-c<span class="w"> </span>conda-forge<span class="w"> </span><span class="nv">python</span><span class="o">=</span><span class="m">3</span>.10<span class="w"> </span><span class="nv">pyomo</span><span class="o">=</span><span class="m">6</span>.4.2<span class="w"> </span><span class="nv">ipopt</span><span class="o">=</span><span class="m">3</span>.14.9<span class="w"> </span>compas<span class="w"> </span>compas_viewer
+conda<span class="w"> </span>activate<span class="w"> </span>cra
 pip<span class="w"> </span>install<span class="w"> </span>compas_assembly<span class="w"> </span>compas_cra
 </pre></div>
 </div>
-<p>To use the CRA viewer, you should also install <code class="xref py py-mod docutils literal notranslate"><span class="pre">compas_viewer</span></code>.</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>install<span class="w"> </span>compas_viewer
-</pre></div>
-</div>
 </section>
 <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>
+<p>The latest version can be installed on <code class="docutils literal notranslate"><span class="pre">osx</span></code> and <code class="docutils literal notranslate"><span class="pre">linux</span></code> from local source using an environment file.</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
+conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-f<span class="w"> </span>environment.yml
 conda<span class="w"> </span>activate<span class="w"> </span>cra-dev
 </pre></div>
 </div>
 <p>Note that this will automatically create an editable install that can be used for development.</p>
 </section>
+<section id="windows">
+<h2>Windows</h2>
+<p>On Windows, the first part of the installation is the same.</p>
+<p>However, once you start using CRA, you will very likely run into a problem with missing <code class="docutils literal notranslate"><span class="pre">ipopt</span></code> binares.
+To solve this, you can download the binaries from the <code class="docutils literal notranslate"><span class="pre">ipopt</span></code> github release and place it in in the correct folder of you environment.
+(Thank you Petras for figuring this out :)</p>
+<p>The bnary of release <code class="docutils literal notranslate"><span class="pre">ipopt=3.14.9</span></code> is available here:</p>
+<ul class="simple">
+<li><p>&lt;<a class="github reference external" href="https://github.com/coin-or/Ipopt/releases/download/releases%2F3.14.9/Ipopt-3.14.9-win64-msvs2019-md.zip">coin-or/Ipopt</a>&gt;</p></li>
+</ul>
+<p>Copy the contents of the <code class="docutils literal notranslate"><span class="pre">bin</span></code> folder of the archive into the <code class="docutils literal notranslate"><span class="pre">Library\bin</span></code> of your environment.
+For example, into <code class="docutils literal notranslate"><span class="pre">C:\Users\You\anaconda3\envs\cra\Library\bin</span></code>.</p>
+<p>If this still doesn’t fix the problem, please let us know.</p>
+</section>
 </section>
 
 
@@ -647,6 +649,7 @@ <h2>Latest</h2>
     <ul class="visible nav section-nav flex-column">
 <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>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#windows">Windows</a></li>
 </ul>
   </nav></div>