https://github.com/rsouza01/star_solver
https://github.com/rsouza01/star_solver
astrophysics equation-of-state numerical-computation python stellar-astrophysics
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rsouza01/star_solver
- Owner: rsouza01
- License: mit
- Created: 2018-01-23T13:27:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-23T23:44:47.000Z (over 7 years ago)
- Last Synced: 2023-03-28T21:05:22.842Z (about 2 years ago)
- Topics: astrophysics, equation-of-state, numerical-computation, python, stellar-astrophysics
- Language: Python
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# STAR SOLVER
The main purpose of this program is to integrate the TOV equations under a given Equation of State.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
## Some references
### Config lib
https://stackoverflow.com/questions/29344196/creating-a-config-file
https://martin-thoma.com/configuration-files-in-python
### Unit tests
https://medium.com/meus-pedidos/tutorial-testes-unit%C3%A1rios-e-python-parte-i-bb77182db93f
https://stackoverflow.com/questions/1896918/running-unittest-with-typical-test-directory-structure
### Prerequisites
What things you need to install the software and how to install them
```
Give examples
```
### Installing
A step by step series of examples that tell you have to get a development env running
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
End with an example of getting some data out of the system or using it for a little demo
## Running the tests
Explain how to run the automated tests for this system
### Break down into end to end tests
Explain what these tests test and why
```
Give an example
```
### And coding style tests
Explain what these tests test and why
```
Give an example
```
## Deployment
Add additional notes about how to deploy this on a live system
## Built With
* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Rodrigo Souza** - *Initial work* - [rsouza01](https://github.com/rsouza01)
See also the list of [contributors](https://github.com/rsouza01/star_solver/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* Hat tip to anyone who's code was used
* Inspiration
* etc