Skip to content

Commit

Permalink
Deploying to gh-pages from @ 48f5f9c 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
jbpezent committed Jun 24, 2024
1 parent 0daeaf2 commit 0f834bb
Show file tree
Hide file tree
Showing 41 changed files with 1,414 additions and 182 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 5c824843bcd42df5ed2cdc3acabdaffe
config: 3d1bae2c42148cab69c877b9471d3730
tags: 645f666f9bcd5a90fca523b33c5a78b7
9 changes: 5 additions & 4 deletions Installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />

<!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 -->
<title>Python: Installing ASSET - ASSET 0.4.0 documentation</title>
<title>Python: Installing ASSET - ASSET 0.5.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=387cc868" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
Expand Down Expand Up @@ -181,7 +181,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">ASSET 0.4.0 documentation</div></a>
<a href="index.html"><div class="brand">ASSET 0.5.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -208,7 +208,7 @@
<img class="sidebar-logo" src="_static/ASSETLOGO.svg" alt="Logo"/>
</div>

<span class="sidebar-brand-text">ASSET 0.4.0 documentation</span>
<span class="sidebar-brand-text">ASSET 0.5.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand All @@ -227,6 +227,7 @@
<li class="toctree-l2"><a class="reference internal" href="tutorials/OptimalControlProblem.html">Optimal Control Problem Tutorial</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/PSIOPT.html">PSIOPT</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/AutoMeshGuide.html">Adaptive Mesh Refinement Tutorial</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/NewInterface.html">Interface Enhancements</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/OptimalControlUtilites.html">Optimal Control Utilities</a></li>
</ul>
</li>
Expand Down Expand Up @@ -381,7 +382,7 @@ <h2>Windows Binary Dependencies<a class="headerlink" href="#windows-binary-depen

</aside>
</div>
</div><script src="_static/documentation_options.js?v=6c02275b"></script>
</div><script src="_static/documentation_options.js?v=1dd76d02"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=4e2eecee"></script>
Expand Down
13 changes: 11 additions & 2 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,13 @@ Cite the following `paper <https://www.researchgate.net/publication/357567956_AS



If you have questions, please email any of:
If you have questions, please email any of the following or post an issue on the GitHub:

[email protected]

[email protected]

[email protected]

[email protected]

Expand All @@ -54,7 +60,7 @@ Open source development and distribution of ASSET is funded by NASA under Grant

Copyright, Licensing, and Legal Notices
#######################################
ASSET is provided under the permissive Apache 2.0 license that can be found in the `LICENSE <https://github.com/AlabamaASRL/asset_asrl/blob/master/LICENSE.txt>`_ file on the Github repo.
ASSET is distributed under the permissive Apache 2.0 license that can be found in the `LICENSE <https://github.com/AlabamaASRL/asset_asrl/blob/master/LICENSE.txt>`_ file on the Github repo.

The license and copyright notices of ASSET's source and redistributable dependencies are shown below. The full text for each respective license can be found in the
`notices <https://github.com/AlabamaASRL/asset_asrl/tree/master/notices>`_ folder on the Github repo.
Expand All @@ -71,6 +77,9 @@ The license and copyright notices of ASSET's source and redistributable dependen

rubber_types - MIT License : Copyright (C) 2014 Andreas J. Herrmann

kepler propagator - MIT License : Copyright (C) 2014 Darin Koblick

lambert solver - MIT License : Copyright (C) 2018 Rody Oldenhuis

..
cpp/cpp_root.rst
Expand Down
53 changes: 41 additions & 12 deletions _sources/tutorials/Install.rst.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
Installing ASSET
================

This tutorial will guide you through the complete setup process for installing and building ASSET from scratch on:
In most cases we suggest simply installing ASSET via pip, which is as simple as running the following command in the console:

.. code-block:: console
pip install asset-asrl
We currently host Windows and Linux binaries for python 3.7-3.12 on PyPi.


If you are interested in building ASSET from source, please see the following sections for a step-by-step guide on how to do so on:

* Windows
* Linux
* Docker
* Docker (Linux)

Windows Installation
--------------------
Build from Source on Windows
----------------------------

In order to build ASSET on Windows the following dependencies are required:

Expand Down Expand Up @@ -136,8 +146,8 @@ Step-By-Step Guide



Linux Installation
------------------
Build from Source on Linux
--------------------------
The dependencies for Linux installations are similar to that of Windows; however, we'll be using Visual Studio Code for our IDE:

* `Visual Studio Code <https://code.visualstudio.com/download>`_
Expand Down Expand Up @@ -253,16 +263,35 @@ If it is desired to use an IDE other than Visual Studio Code, it is still requir
Docker
------

Want to skip installing all of the dependencies? ASSET can be installed through a Docker image. There's also great integrations of Docker and VS Code.
The `dockerfiles <https://github.com/AlabamaASRL/asset_asrl/tree/master/dockerfiles>`_ folder in the repo contains docker files and supporting scripts for building asset_asrl .whl files for pip installation on linux systems.
Two images are provided based on Ubuntu 18.04 and 20.04. Build wheels on 18.04 for better compatibility with older linux distros or 20.04 for better performance.


To use, cd to the desired image's folder and build the image. You may optionally set the number of cores used building the image with the
CMakeBuildJobs build argument.

.. code-block:: console
cd Ubuntu18.04
docker build -t assetbuild . --build-arg CMakeBuildJobs=12
After building the image, start up a new container.

.. code-block:: console
docker run -it assetbuild /bin/bash
Once inside the container, run the BuildWheel.sh script to build a .whl file for a particular python version (-p), repo branch (-b).
You may also set the number of jobs used when compiling with the -j argument.

Download the Docker/VS Code project template here and get to coding!
.. code-block:: console
https://github.com/jasonmeverett/asset-example-project
bash ~/BuildWheel.sh -b master -j 12 -p 3.10
Developing Docker Images
^^^^^^^^^^^^^^^^^^^^^^^^
After the build has completed, the packaged wheel file will be available in ~/asset_asrl/wheelhouse. You can then copy this file out of the container
for installation on other systems.

Interested in contributing to Docker/ASSET development? Check in-depth details in `Dockerfile` and `Dockerfile-dev` in the repository.



Expand Down
Loading

0 comments on commit 0f834bb

Please sign in to comment.