/astro3d

Package to create a 3D model from an astronomical image.

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Astro3d

Astro3d provides a GUI and engine to create a 3D model from an astronomical image. The 3D model is saved in a STL file, which can then be sent to a 3D printer.

Requirements

  • Python 3
  • Qt5

Installation

Start a terminal window

In whatever system you have, start a terminal window that will get you to the command line.

Remember, you need to be in the bash shell. If not sure, start bash:

$ bash

Install Anaconda

If you have never installed anaconda before, or want to start fresh, this is the place to start. First, remove any previous instance of anaconda:

$ cd
$ rm -rf anaconda3

Go to the Anaconda download site, https://www.anaconda.com/download/, and download the command line installer appropriate for your system. Choose the Python3.x version.

After downloading, perform the installation:

$ cd <download_directory_here>
$ bash <install_script_here>

Accept all the defaults for any questions asked.

Now, quit the terminal window you were in and start another one. Remember to start bash if necessary.

Create environment

Now we can create the astro3d Python environment. We will use the stenv environment, which is a conda environment that contains all the necessary packages for astro3d.

Create the astro3d conda environment:

$ conda env create -n astro3d -f https://raw.githubusercontent.com/spacetelescope/stenv/main/environment.yaml

The astro3d environment is now ready. To activate, do the following:

$ conda activate astro3d

Always Do

At this point, the environment is setup. From now on, always make sure you are running bash and in the astro3d environment whenever you need to start a new terminal window:

$ conda activate astro3d

astro3d code install

If one has never installed astro3d or one wishes to get a fresh install, do the following. Remember to start bash and activate the environment before doing this:

$ cd
$ rm -rf astro3d
$ git clone git@github.com:spacetelescope/astro3d.git
$ cd astro3d
$ pip install .

The application should now be runnable. Note, you can run the application from whatever directory you wish:

$ astro3d

Updating astro3d

To update the code, do the following. Remember to start bash and activate the environment:

$ cd
$ cd astro3d
$ git pull
$ pip install .

This should do it.