Skip to content

Commit

Permalink
deploy: f28c42d
Browse files Browse the repository at this point in the history
  • Loading branch information
jmeneghini committed Jan 20, 2024
1 parent e8e86f4 commit f32341b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,14 @@ <h2><a class="anchor" id="autotoc_md5"></a>
<li>Generate cmake files and install: <div class="fragment"><div class="line">cmake ..</div>
<div class="line">sudo make install</div>
</div><!-- fragment --></li>
<li>To build all the cpp_simulations (not required) assuming you are still in the build directory: <div class="fragment"><div class="line">./../utility_scripts/build_cpp_sims.sh</div>
</div><!-- fragment --></li>
</ol>
<h2><a class="anchor" id="autotoc_md6"></a>
Installation (Docker)</h2>
<p>MIDSX can be built and run in a Docker container. This is currently the only way to build on MacOS. \ \ If you don't have Docker installed, follow the instructions for Docker Desktop <a href="https://docs.docker.com/desktop/">(GUI)</a> or for Docker Engine <a href="https://docs.docker.com/engine/install/">(CLI)</a>. Docker has excellent documentation, so if you have any issues, refer to their website. \ \ To pull the Docker image from Docker Hub: </p><div class="fragment"><div class="line">docker pull jmeneghini/midsx:latest</div>
</div><!-- fragment --><p> Then, to run the container with an interactive shell: </p><div class="fragment"><div class="line">docker run -it jmeneghini/midsx:latest</div>
</div><!-- fragment --><p> The container will have already installed MIDSX and its dependencies, so you can start using it right away.</p>
</div><!-- fragment --><p> The container will have already installed/compiled MIDSX, its dependencies, and the cpp_simulations, so you can start using it right away.</p>
<h1><a class="anchor" id="autotoc_md7"></a>
Documentation</h1>
<p>The <a href="https://jmeneghini.github.io/MIDSX/">documentation</a> for MIDSX is generated via Doxygen and is hosted with Github Pages. \ \ The preprint for the validation of MIDSX can be found on <a href="https://arxiv.org/abs/2311.16873">arXiv</a>.</p>
Expand Down

0 comments on commit f32341b

Please sign in to comment.