Getting Started With The sscws Python Library

Introduction

The following information is intended to help someone begin using the sscws Python library to access information from NASA's Satellite Situation Center in a Python program. This information will focus on only a few different Python environments but may also be helpful in the numerous other Python environments that are not explicitly covered. The environments described here include the following:

Basic Virtual Environment (venv)
Jupyter Notebook
Thonny IDE

Basic Virtual Environment

This section contains information on getting start with the sscws library in a Python 3.3 or higher venv lightweight virtual environment.

Linux/macOS

Most Linux distributions have Python installed. But if the Linux distribution you use does not, it is usually available from the distribution's standard repository and can be installed following the usual procedures for installing optional software.

For macOS, obtain and install Python from https://www.python.org/ or an approved source for an enterprised-managed computer.

On a Linux/Mac computer, copy and paste the following into a terminal/shell window.

cd ~/Downloads
mkdir sscws
cd sscws
python3 -m venv sscws
source sscws/bin/activate
pip install sscws matplotlib
curl -sOJ "https://sscweb.gsfc.nasa.gov/WS/sscr/2/observatories/iss/clientLibraryExample/sscwspy"
python3 sscws_iss_example.py

You should see the output from the sscws_iss_example.py example and a window with a 3D plot of the ISS orbit. You can modify sscws_iss_example.py yourself or write your own code that uses the sscws library to access SSC data.

When you no longer want the example code and environment, do the following in the shell window

deactivate
cd
rm -rf ~/Downloads/sscws

Microsoft Windows

On a Microsoft computer, install python from the Microsoft App Store, https://www.python.org/ , or an approved source for an enterprised-managed computer. Then, copy and paste the following into a Terminal (PowerShell) window.

cd Downloads
mkdir sscws
cd sscws
python -m venv sscws
sscws\Scripts\activate.bat
pip install sscws matplotlib
C:\Windows\System32\curl -s -O -J "https://sscweb.gsfc.nasa.gov/WS/sscr/2/observatories/iss/clientLibraryExample/sscwspy"
python sscws_iss_example.py

When you no longer want the example code and environment, do the following in the Terminal (PowerShell) window

sscws\Scripts\deactivate.bat
cd ..
Remove-Item -Path "sscws" -Recurse -Force

Jupyter Notebook

This section contains information on getting start with the sscws library in a Python Jupyter notebook environment. The following will give you run/modify access to the example notebooks shown here.

Linux/macOS

On a Linux/Mac computer with Python installed, copy and paste the following into a terminal/shell window.

cd Downloads
mkdir sscws-nb
cd sscws-nb
python3 -m venv sscws-nb
source sscws-nb/bin/activate
pip install sscws matplotlib xarray cdflib cdasws notebook
curl -sOJ "https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWs{Example,BTraceExample,RadialConjunction,ConjunctionExample}.ipynb"
python3 -m notebook

This may take some time to complete. Once it does, you should see the jupyter notebook dashboard in your browser with the SSC example notebook files. Select one of the SSC examples in the notebook to run/edit. It should look similar to this page except that it will be editable. Select the Cell/Run All menu item to execute the entire notebook. You can modify any of the example notebooks or write your own.

When you no longer want the example code and environment, Quit the notebook and do the following in the terminal/shell window

deactivate
cd
rm -rf ~/Downloads/sscws-nb

Microsoft Windows

On a Microsoft computer with python installed, copy and paste the following into a Terminal (PowerShell) window.

cd Downloads
mkdir sscws-nb
cd sscws-nb
python -m venv sscws-nb
sscws-nb\Scripts\activate.bat
pip install sscws matplotlib xarray cdflib cdasws notebook
C:\Windows\System32\curl -s -O -J "https://sscweb.gsfc.nasa.gov/WebServices/REST/jupyter/SscWs{Example,BTraceExample,RadialConjunction,ConjunctionExample}.ipynb"
python -m notebook

This may take some time to complete. Once it does, you should see the jupyter notebook dashboard notebook dashboard in your browser with the SSC example notebook files. Select one of the SSC examples in the notebook to run/edit. It should look similar to this page except that it will be editable. Select the Cell/Run All menu item to execute the entire notebook.

When you no longer want the example code and environment, Quit the notebook and do the following in the Terminal (PowerShell) window

deactivate
cd ..
Remove-Item -Path "sscws-nb" -Recurse -Force

Thonny IDE

This section contains information on using the sscws library in a Thonny Integrated Development Environment (IDE). Thonny is one of many Python IDEs. It is available for installation on Microsoft Windows, Apple macOS, and many Linux distributions. On a computer with Thonny installed, merely click here to download the sscws example code from this page. Depending upon the configuration of your computer, Thonny will automatically start with the example code or you may be asked which application should handle the file. If asked, select Thonny as the application to open the file with. Before attempting to run the code, do the following:

From the Tools menu, select Options.
Select the Interpreter tab.

Select the New virtual environment link at the bottom of the tab.
On the file chooser window, create a new folder name, for example, "sscws" and select it. It will take a few seconds to create.
Select ok to close the Thonny options window.
From the Tools menu, select Manage packages.

Enter sscws in the search field and click the Search on PyPI button.
Click the Install button to install the sscws package.

Now you can close the Manage packages window and select the Run button. That should result in the following

execution of sscws example code

Questions/Comments

Questions or comments concerning these Web services should be sent to SSC Feedback.