Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with new information #21

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
### Table of contents
[Overview](#Overview)
[Results/Output](#Results/Output)
[Installation](#installation)
[Source](#source)
[Docker](#docker)
[Application_Guide](#application-guide)
[Issues](#issues)
[Contributions](#contributions)


# ATM
Asteroid Thermal Modeling
[![Build Status](https://dev.azure.com/moeyensj/atm/_apis/build/status/moeyensj.atm?branchName=master)](https://dev.azure.com/moeyensj/atm/_build/latest?definitionId=3&branchName=master)
[![Build Status](https://www.travis-ci.com/moeyensj/atm.svg?token=sWjpnqPgpHyuq3j7qPuj&branch=master)](https://www.travis-ci.com/moeyensj/atm)
[![Coverage Status](https://coveralls.io/repos/github/moeyensj/atm/badge.svg?branch=master&t=wABWWi)](https://coveralls.io/github/moeyensj/atm?branch=master)
[![Docker Pulls](https://img.shields.io/docker/pulls/moeyensj/atm)](https://hub.docker.com/r/moeyensj/atm)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

## Overview

*** consider adding more in this section about what the project does and why you guys created it. This would be helpful for users trying to use your project***

This is the main code repository that contains the ATM code. While this code can be used in a standalone fashion, please consider also downloading the atm_notebooks and atm_data repositories.

The reference paper "ATM: An open-source tool for asteroid thermal modeling and its application to NEOWISE data" can be found at: https://doi.org/10.1016/j.icarus.2019.113575.
Expand All @@ -22,6 +34,10 @@ We recommend installing the code along one of two installation paths: either a s

### Source

*** Try to update how to install the software for this project. I tried these methods several times and all of them failed.
The primary issue I was having was I was unsure how to use conda since it is not described in this section. I also was unable to do the pip install since
my system said there was an error on line 7 of the requirements.txt it is possible I do not have somehting necessary for this command to work, but this should be mentioned in the project installation heading.

Clone this repository using either `ssh` or `https`:

```GIT_LFS_SKIP_SMUDGE=1 git clone [email protected]:moeyensj/atm.git```
Expand Down Expand Up @@ -70,3 +86,20 @@ To run the container:
The ATM code is installed the /projects directory, and is by default also installed in the container's Python installation.

**If you would like to run Jupyter Notebook or Juptyter Lab with ATM please see the installation instructions in the ATM notebooks repository.**

### Application Guide

Please consider adding this section to your readme. I was hoping to be able to create this section with relevent information to improve the readme and its functionality, but I was unable to run the project, so this was impossible for me.

### Issues

Please consider addding this section to your documentation so that is anyone has any issues running the project they will be able to contact you. This would be very helpful
for future people trying to use your software.

### License

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

### Contributions

Consider adding this section so that everyone that adds a significant contribution to this project can get recognition for their work.