Skip to content

Commit

Permalink
Updates to remove old instructions for building a wheel
Browse files Browse the repository at this point in the history
  • Loading branch information
@ehinrichs
ehinrichs committed Feb 20, 2025
1 parent a8a13d9 commit 8bf4489
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 36 deletions.
Binary file modified Documentation/sphinx-docs/build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified Documentation/sphinx-docs/build/doctrees/setup.doctree
View file
Binary file not shown.
18 changes: 10 additions & 8 deletions Documentation/sphinx-docs/build/html/_sources/setup.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,26 +103,28 @@ Alternatively, you can create a ``.dfnworksrc`` file in your home directory with
Installing pydfnworks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Go up into the pydfnworks sub-directory:

.. code-block:: bash
$ cd dfnWorks/pydfnworks/
Complie The pydfnWorks Package:
Compile The pydfnWorks Package & Install on Your Local Machine:

.. code-block:: bash
$ python setup.py bdist_wheel
$ pip install -r requirements.txt
Install on Your Local Machine:
or

.. code-block:: bash
$ python -m pip install dist/pydfnworks-2.6-py3-none-any.whl
**Note that the python version in dist/ needs to be consistent with the current release**
$ pip install -r requirements.txt --user
if you don't have admin privileges.

**Note that the python version needs to be consistent with the current release**

Installation Requirements for Native Build
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion Documentation/sphinx-docs/build/html/searchindex.js
View file

Large diffs are not rendered by default.

11 changes: 6 additions & 5 deletions Documentation/sphinx-docs/build/html/setup.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,15 +197,16 @@ <h3>Installing pydfnworks<a class="headerlink" href="#installing-pydfnworks" tit
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>dfnWorks/pydfnworks/
</pre></div>
</div>
<p>Complie The pydfnWorks Package:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python<span class="w"> </span>setup.py<span class="w"> </span>bdist_wheel
<p>Compile The pydfnWorks Package &amp; Install on Your Local Machine:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
</pre></div>
</div>
<p>Install on Your Local Machine:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>dist/pydfnworks-2.6-py3-none-any.whl
<p>or</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt<span class="w"> </span>--user
</pre></div>
</div>
<p><strong>Note that the python version in dist/ needs to be consistent with the current release</strong></p>
<p>if you don’t have admin privileges.</p>
<p><strong>Note that the python version needs to be consistent with the current release</strong></p>
</section>
<section id="installation-requirements-for-native-build">
<h3>Installation Requirements for Native Build<a class="headerlink" href="#installation-requirements-for-native-build" title="Link to this heading"></a></h3>
Expand Down
18 changes: 10 additions & 8 deletions Documentation/sphinx-docs/source/setup.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,26 +103,28 @@ Alternatively, you can create a ``.dfnworksrc`` file in your home directory with
Installing pydfnworks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Go up into the pydfnworks sub-directory:

.. code-block:: bash
$ cd dfnWorks/pydfnworks/
Complie The pydfnWorks Package:
Compile The pydfnWorks Package & Install on Your Local Machine:

.. code-block:: bash
$ python setup.py bdist_wheel
$ pip install -r requirements.txt
Install on Your Local Machine:
or

.. code-block:: bash
$ python -m pip install dist/pydfnworks-2.6-py3-none-any.whl
**Note that the python version in dist/ needs to be consistent with the current release**
$ pip install -r requirements.txt --user
if you don't have admin privileges.

**Note that the python version needs to be consistent with the current release**

Installation Requirements for Native Build
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
18 changes: 10 additions & 8 deletions docs/_sources/setup.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,26 +103,28 @@ Alternatively, you can create a ``.dfnworksrc`` file in your home directory with
Installing pydfnworks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Go up into the pydfnworks sub-directory:

.. code-block:: bash
$ cd dfnWorks/pydfnworks/
Complie The pydfnWorks Package:
Compile The pydfnWorks Package & Install on Your Local Machine:

.. code-block:: bash
$ python setup.py bdist_wheel
$ pip install -r requirements.txt
Install on Your Local Machine:
or

.. code-block:: bash
$ python -m pip install dist/pydfnworks-2.6-py3-none-any.whl
**Note that the python version in dist/ needs to be consistent with the current release**
$ pip install -r requirements.txt --user
if you don't have admin privileges.

**Note that the python version needs to be consistent with the current release**

Installation Requirements for Native Build
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Large diffs are not rendered by default.

11 changes: 6 additions & 5 deletions docs/setup.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,15 +197,16 @@ <h3>Installing pydfnworks<a class="headerlink" href="#installing-pydfnworks" tit
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>dfnWorks/pydfnworks/
</pre></div>
</div>
<p>Complie The pydfnWorks Package:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python<span class="w"> </span>setup.py<span class="w"> </span>bdist_wheel
<p>Compile The pydfnWorks Package &amp; Install on Your Local Machine:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
</pre></div>
</div>
<p>Install on Your Local Machine:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>dist/pydfnworks-2.6-py3-none-any.whl
<p>or</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt<span class="w"> </span>--user
</pre></div>
</div>
<p><strong>Note that the python version in dist/ needs to be consistent with the current release</strong></p>
<p>if you don’t have admin privileges.</p>
<p><strong>Note that the python version needs to be consistent with the current release</strong></p>
</section>
<section id="installation-requirements-for-native-build">
<h3>Installation Requirements for Native Build<a class="headerlink" href="#installation-requirements-for-native-build" title="Link to this heading"></a></h3>
Expand Down

0 comments on commit 8bf4489

Please sign in to comment.