Skip to content

Commit

Permalink
Merge pull request #15 from mtauraso/link-fix
Browse files Browse the repository at this point in the history
Documentation fixups
  • Loading branch information
aritraghsh09 committed Aug 2, 2024
2 parents d9727ce + 7b0a9b1 commit 88ce441
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Status of Build and Tests Workflow](https://github.com/aritraghsh09/GaMPEN/actions/workflows/main.yml/badge.svg)](https://github.com/aritraghsh09/GaMPEN/actions/workflows/main.yml)
[![Documentation Status](https://readthedocs.org/projects/gampen/badge/?version=latest)](https://gampen.readthedocs.io/en/latest/?badge=latest)
[![Python Version 3.7 and above](https://img.shields.io/badge/Python-3.7%2B-blue)](https://www.python.org/downloads/)
[![Python Version 3.8](https://img.shields.io/badge/Python-3.8-blue)](https://www.python.org/downloads/)
[![GitHub license](https://img.shields.io/github/license/aritraghsh09/GaMPEN)](https://github.com/aritraghsh09/GaMPEN/blob/master/LICENSE)
[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Code DOI](https://zenodo.org/badge/299731956.svg)](https://zenodo.org/badge/latestdoi/299731956)
Expand Down
2 changes: 1 addition & 1 deletion docs/source/About_Gampen.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ and flux -- are fairly stable against rotations.


## Publications
GaMPEN was initially introduced in [Ghosh et al. 2022](https://iopscience.iop.org/article/10.3847/1538-4357/ac7f9e) with a companion catalog of Hyper Suprime-Cam Galaxy Structural Parameters in [Ghosh et al. 2023](https://doi.org/10.3847/1538-4357/ac7f9e).
GaMPEN was initially introduced in [Ghosh et al. 2022](https://iopscience.iop.org/article/10.3847/1538-4357/ac7f9e) with a companion catalog of Hyper Suprime-Cam Galaxy Structural Parameters in [Ghosh et al. 2023](https://iopscience.iop.org/article/10.3847/1538-4357/acd546).

Since then, GaMPEN has been used in other publications. We always try to maintain an updated record of GaMPEN's trained models and associated catalogs [on this page](./Public_data.md).

Expand Down
4 changes: 2 additions & 2 deletions docs/source/Getting_Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
GaMPEN is written in Python and relies on the [PyTorch](https://pytorch.org/) deep learning library to perform all of its tensor operations.

## Installation
Training and inference for GaMPEN requires Python 3.7+. Trained GaMPEN models can be run on a CPU to perform inference, but training a model requires access to a CUDA-enabled GPU for reasonable training times.
Training and inference for GaMPEN requires Python 3.7 or 3.8. Trained GaMPEN models can be run on a CPU to perform inference, but training a model requires access to a CUDA-enabled GPU for reasonable training times.

1. Create a new conda environment with Python 3.7+. Extensive instructions on how to create a conda enviornment can be found [here](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands). Of course, you could use any other method of creating a virtual environment, but we will assume you are using conda for the rest of this guide.
1. Create a new conda environment with Python 3.7 or 3.8. Extensive instructions on how to create a conda enviornment can be found [here](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands). Of course, you could use any other method of creating a virtual environment, but we will assume you are using conda for the rest of this guide.
```bash
conda create -n gampen python=3.7
```
Expand Down

0 comments on commit 88ce441

Please sign in to comment.