nucad 0.1.0a3

CAD tool focused on designing nuclear physics experimental instruments

NuCAD

NuCAD is a CAD tool focused on designing nuclear physics experimental instruments.

Getting Started

NuCAD Installation via PIP

pip install nucad

NuCAD depends on CadQuery and OCP. If you have any troubles, consider to install cadquery using mamba.

mamba create -n nucad -c conda-forge \
  python=3.12 numpy cadquery ocp
mamba activate nucad
pip install pycatima nucad

Using NuCAD in Apptainer

1. Clone the apptainer definition file.

git clone https://github.com/yano404/nucad_apptainer.git

2. Build SIF container.

cd nucad_apptainer
apptainer build nucad.sif nucad.def

3. Run the container.

apptainer run nucad.sif

4. Visit http://localhost:54321 in your web browser. You will see Jupyter Lab running on the port.

Building NuCAD from Source

1. Clone this repository.

git clone https://github.com/yano404/NuCAD.git

2. Build NuCAD by using uv .

cd /path/to/nucad
uv build

3. Install NuCAD to your enviroment.

pip install .

License

Copyright (c) 2025 Takayuki YANO

The source code is licensed under the MIT License, see LICENSE.