Skip to content

Commit c49829b

Browse files
author
[Mackenze Fahey]
committed
added readme and license
1 parent ebc1b76 commit c49829b

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Mackenzie Fahey
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Spectrochemical Energy Converter
2+
3+
## Description
4+
Command-line tool written in python that allows scientists to quickly and easily convert common energy units used.
5+
6+
## Project Status
7+
This project has been expanded to be used on mobile platforms as opposed to being used as a command line tool. This project will be updated with added units that are included or added to the mobile app.
8+
9+
## Installation
10+
Must have python installed on PC/linux and the EnergyConversions.py saved in parent directory to use conversions.
11+
12+
## Usage
13+
The project can be used as a command-line tool:
14+
15+
```bash
16+
python EnergyConversions.py
17+
```
18+
19+
or the conversions can be run as standalone functions:
20+
21+
```python
22+
import EnergyConversions
23+
24+
#converts 5 eV to wavenumbers
25+
EnergyConversions.convert2wavenumber('eV', 5)
26+
27+
#converts 200 nm to eV
28+
EnergyConversions.convert2eV('nm', 200)
29+
```
30+
31+
## Support
32+
Contact the author at [email protected]
33+
34+
## Roadmap
35+
No planned updates.
36+
37+
## Contributing
38+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
39+
40+
Please make sure to update tests as appropriate.
41+
42+
# Authors and Acknowledgment
43+
Mackenzie Fahey
44+
45+
mmfahey Programming
46+
47+
48+
49+
https://mmfahey-portfolio-app.herokuapp.com/
50+
51+
https://github.com/mmfahey
52+
53+
## License
54+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)