> ## Documentation Index
> Fetch the complete documentation index at: https://magisim.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Start using Magisim Core Now

## System Requirements

* At least 4GB of system memory
* Linux or UNIX-like operating system
* Anaconda / Miniconda

### Install

#### Deploy locally

<AccordionGroup>
  <Accordion icon="github" title="Download Magisim">
    Clone the Magisim GitHub repository using the following command:\
    `git clone https://github.com/devbrones/magisim`
  </Accordion>

  <Accordion icon="rectangle-terminal" title="Set up your local environment">
    Move into the repository and create the Anaconda environment:\\

    `cd magisim`\
    `conda env create -f msenv.yml`\
    `conda activate msenv`

    Install Redis:

    Debian/Ubuntu:\
    `sudo apt install redis redis-server`

    Clone our forked simulation library to use the built in FDTD simulator:

    `cd .. && git clone https://github.com/devbrones/fdtd`\
    `cd fdtd`\
    `pip install ./fdtd`\\
  </Accordion>
</AccordionGroup>

#### Deploy in a container

coming soon

## Run Magisim

Change to the Anaconda environment:\
`conda activate msenv`

Change to the UI directory:\
`cd src/ui`

Start Magisim:\
`sh start.sh`
