Skip to content

Commit

Permalink
Deploying to gh-pages from @ 82c7e4c 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
asyms committed Dec 9, 2024
1 parent 0a5be5a commit 49adee7
Show file tree
Hide file tree
Showing 22 changed files with 39 additions and 33 deletions.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/installation.doctree
Binary file not shown.
27 changes: 14 additions & 13 deletions _sources/installation.rst.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
===================
Installing ZigZag
===================
============
Installation
============

This guide provides step-by-step instructions for setting up ZigZag. If you're already familiar with Python development environments and IDEs, you can skip to the **Installing ZigZag** section below.

=======================
Setting Up the Basics
=======================
Environment
===========

To use ZigZag effectively, we recommend setting up a Python virtual environment and optionally using an IDE like VS Code. Of course, you may use any IDE of your choice.

Expand All @@ -19,41 +18,43 @@ Linux/Mac
~~~~~~~~~
1. **Install Python 3.11 or newer**:
Ensure you have Python installed. You can check with:

.. code-block:: sh
python3 --version
Install Python if necessary via your package manager or from the [official website](https://www.python.org/downloads/).
Install Python if necessary via your package manager or from the `official website <https://www.python.org/downloads/>`_.

2. **Set up a virtual environment**:

.. code-block:: sh
python3 -m venv zigzag_env
source zigzag_env/bin/activate
3. **Install VS Code (Optional)**:
Download and install VS Code from [here](https://code.visualstudio.com/). Add the Python extension for an enhanced development experience.
Download and install VS Code from `here <https://code.visualstudio.com/>`_. Add the Python extension for an enhanced development experience.

Windows
~~~~~~~
1. **Install Python 3.11 or newer**:
Download Python from the [official website](https://www.python.org/downloads/). Ensure you check the box to "Add Python to PATH" during installation.
Download Python from the `official website <https://www.python.org/downloads/>`_. Ensure you check the box to "Add Python to PATH" during installation.

2. **Set up a virtual environment**:
Open Command Prompt or PowerShell and run:

.. code-block:: sh
python -m venv zigzag_env
zigzag_env\Scripts\activate
3. **Install VS Code (Optional)**:
Download and install VS Code from [here](https://code.visualstudio.com/). Add the Python extension for an enhanced development experience.
Download and install VS Code from `here <https://code.visualstudio.com/>`_. Add the Python extension for an enhanced development experience.

**Note**: If you already have your development environment set up, you can skip to the **Installing ZigZag** section below.

==========================
Installing ZigZag
==========================
=================

Installing as a Package
-----------------------
Expand Down Expand Up @@ -102,4 +103,4 @@ Installation Steps
Alternatively, an Anaconda spec file is also provided if you prefer to use conda.

3. **Run ZigZag**:
You can now execute ZigZag through the main file with the provided arguments. For more details, see the :doc:`getting-started` documentation.
You can now execute ZigZag through the main file with the provided arguments. For more details, see the :doc:`getting-started` documentation.
2 changes: 1 addition & 1 deletion api.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion code-documentation.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion contribute.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion future.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion genindex.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions getting-started.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion hardware.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion index.html

Large diffs are not rendered by default.

9 changes: 7 additions & 2 deletions installation.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion mapping.html

Large diffs are not rendered by default.

Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion outputs.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion publications.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion search.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion stages.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion user-guide.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion visualization.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion workload.html

Large diffs are not rendered by default.

0 comments on commit 49adee7

Please sign in to comment.