Develop

Development

• Our Python tools are set up to use uv. Simply git clone a repo:

  git clone https://github.com/darkshapes/nnll
  cd nnll
  

  git clone https://github.com/darkshapes/zodiac
  cd zodiac
  

  git clone https://github.com/darkshapes/sdbx
  cd sdbx
  

  git clone https://github.com/darkshapes/mir
  cd mir
  

  then:

  uv sync --group dev
  

  You can also try commands from Zodiac, MIR, sdbx or nnll without any installation:

  uvx --from git+https://github.com/darkshapes/zodiac zodiac
  

• For singularity :

  We use Bun for TypeScript/React projects.

  Clone the repo

  git clone https://github.com/darkshapes/singularity
  

  Then install and open your dev copy:

  cd singularity
  bun install
  bun run dev
  

Tip

To use 3D graphics cards, please ensure current drivers are installed.

NVIDIA Drivers

AMD Drivers

INTEL drivers

If you are developing or using .gguf format, it is likely you will also need to compile with the installed toolkit appropriate for your card.

CUDA Toolkit

ROCm/HIP SDK Windows / ROCm SDK Linux

MacOS users with M-series GPU who wish to use llamafile with .gguf should install XCode Command Line Tools (1.2gb) using Terminal:

xcode-select --install

or via Apple developer site, or through the XCode app (40gb)

Pip Setup

---

• Follow the Python instructions

• Install Git (Windows Only)

• Configure advanced GPU settings (OPTIONAL. Linux, flash-attn, PyTorch compile, etc)

• Clone your repo(s)

  For sdbx :

  git clone https://github.com/darkshapes/sdbx
  pip install -e "sdbx[dev]"
  sdbx
  ```<hr>
  

  For Zodiac :

  git clone https://github.com/darkshapes/zodiac.git
  pip install -e "zodiac[dev]"
  

  Linux users want to ensure libportaudio2 is installed via system package manager. MacOS users should have 'ffmpeg', if not install using brew. This doesn't apply to Windows.

  Ensure Ollama, LMStudio, Cortex, Llamafile is running your models of choice. Then use this command to open the terminal client:

  zodiac
  

  Furthermore, Zodiac is designed to work on a mobile device using the serve command. An independent session can be opened with the method from the same Wi-Fi network using browser or SSH.

  ---

  For nnll :

  git clone https://github.com/darkshapes/nnll
   pip install -e "zodiac[dev]"
  

Directions for use

General Development Reference

*  Environment   : uv
*  Logging       : structlog (viztrace on crashes) to `/log` folder
*  Testing       : pytest -vv tests
*  Formatting    : ruff/better align
*  Linting       : ruff/pylint
*  Type Checking : pylance/pyright
*  Spelling      : typos vsc
*  Docstrings    : sphinx

Important

Review the Contributing documentation for more information.

This will help you understand our project's guidelines and what you might enjoy helping with.

Happy Hacking!