Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
talister committed Feb 8, 2024
1 parent e4b247a commit c548ee7
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,43 @@ This is a generalized Exposure Time Calculator for imaging and spectroscopic ins
* various optical glasses (BK7, CaF2, FK5, fused silica etc)
* sky background/atmospheric emission data
* filter transmissions for LCO and selected ones from ESO, ING, Gemini, SOAR

## Usage

## Development Guide - Getting started

Before installing any dependencies or writing code, it's a great idea to create a
virtual environment. We primarily use regular `virtualenv`s to manage virtual
environments, although `conda` *may* work. Using virtualenv, you can run the
following to create and activate a new environment:

```
>> python -m venv /path/to/new/virtual/environment
>> source /path/to/new/virtual/environment/bin/activate
```

(On Windows, invoke the venv command as follows:

```
>> C:\>Python310\python -m venv C:\path\to\myenv
>> C:\> C:\path\to\myenv\Scripts\activate.bat (cmd.exe)
or
>> PS C:\> C:\path\to\myenv\Scripts\Activate.ps1 (PowerShell)
```)
If you have conda installed locally, you can run the following to
create and activate a new environment.
```
>> conda create env -n <env_name> python=3.10
>> conda activate <env_name>
```
Once you have created a new environment, you can install this project for local
development using the following commands:
```
>> pip install -e .
>> pip install -e .'[dev]'
>> pre-commit install
```

0 comments on commit c548ee7

Please sign in to comment.