Recommended Software
There is no wrong way to use Python or the HySite rep, but here, you can find the software and applications that the Hypatia Catalog team uses. Use what you like, or see some of our favorite tools below.
Hypatia supports all operating systems (Mac, Windows, and Linux flavors), so you must follow the installation instructions specific to your computer.
Python is needed for science users and data pipeline developers. However, you can also use Docker to run Python without installing it on your system. Docker instructions are below.
Tip
Most of the HySite instructions will include methods for running commands in Python natively on your machine and the Docker commands to run Python within a container.
We love Python and eagerly await the newest releases each October. Treat yourself to the latest release from the Python website.
We use Python installers that provide instructions and options. We select all add-ons that are offered (Debug binaries, Tk, and others), which differ by operating system.
At the end of the installation, you must install the certificates by running the Install Certificates.command Script; otherwise, you will get an error when you run anything with Python. We all recommend running the Update Shell Profile.command. Install both/either by double-clicking on the file icon in the pop-up Finder window.
Docker has excellent instruction and documentation. You will install the Docker-Desktop application if you are a Windows or Mac user. If you are Linux-person then you will install it from the command line and use it from the command line.
https://docs.docker.com/engine/install/
Tip
If you use Docker often, consider enabling it to start with your computer.
Consider picking a code editor to help you write and execute your code. The code in HySite is a text file, so there are many options and no wrong answers.
Pycharm is a Python-specific editor from JetBrains. This is the default editor for the HypatiaCatalog scientists and developers. The major downside to PyCharm (and JetBrains products) is their cost. However, you can apply for a free license if you are a student or teacher using your .edu email address. After obtaining a license, download Pycharm-Professional.
VScode is free and has many features and plugins professional developers use. It is a good, fully-featured alternative to PyCharm.
Git is version control software, a tool to track changes made to code, allowing many people to edit and share code without safely overwriting changes made by others. It also allows you to go back to previous versions of your code, eliminating the need to save multiple versions of the same file with only minor changes. This reduces the complexity of code file management, which means more time for fun and less time searching through files looking for what you need.
Download Git at https://git-scm.com/downloads
Tip
A Git-repository is a collation of files that are version-controlled by Git
You may notice that this Wiki page is on GitHub. GitHub is a web-based service that hosts git repositories. The main problem GitHub solves for the HypatiaCatalog team is how to synchronize the git-repositories (code files) across multiple computers and users. However, GitHub does a lot more and enables us to share (and showcase) the HypatiaCatalog code with the rest of the world. Sign up at github.com/
Warning
Pick a username that does not reveal too much personal information. People will see this name and associate it with your work.
The HypatiaCatalog Database-software is MongoDB. We interact with this database many through Python functions with the package pymongo. However, Sometimes, using other tools to visualize data is helpful, and we use the free GUI software MongoDb Compass.