https://github.com/riverma/terraformly

An entirely fake project to demonstrate repository best practices.
https://github.com/riverma/terraformly

Last synced: over 1 year ago
JSON representation

An entirely fake project to demonstrate repository best practices.

• Host: GitHub
• URL: https://github.com/riverma/terraformly
• Owner: riverma
• License: mit
• Created: 2022-03-21T23:35:46.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-22T19:51:33.000Z (almost 2 years ago)
• Last Synced: 2025-02-14T20:36:59.771Z (over 1 year ago)
• Language: Python
• Size: 38.1 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          








  

  ![](https://www.nasa.gov/sites/default/files/styles/side_image/public/thumbnails/image/nasa-logo-web-rgb.png?itok=uDhKSTb1)

  

  



  
Terraformly

  





    A Python package designed to quickly and efficiently terraform a planet.



![](https://img.shields.io/github/last-commit/riverma/terraformly) ![](https://img.shields.io/github/downloads/riverma/terraformly/total) ![](https://img.shields.io/github/stars/riverma/github_test_area?style=social) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)

![](https://picsum.photos/id/1002/1024/800)

This software was created to terraform an entire planet. It takes only seconds to launch. It's intended to be used by heads of state only. 

[Website]() | [Wiki](https://github.com/riverma/terraformly/wiki) | [Discussion Board]() | [Issue Tracker](https://github.com/riverma/terraformly/issues)

## Features

* Terraform a terrestrial planet in seconds

* Generate logs of terraforming actions completed

* Future-proof terraforming for long-lasting results

## Contents

* [Quick Start](#quick-start)

* [Changelog](#changelog)

* [FAQ](#frequently-asked-questions-faq)

* [Contributing Guide](#contributing)

* [License](#license)

* [Support](#support)

## Quick Start

This guide provides a quick way to get started with our project. Please see our [docs]() for a more comprehensive overview.

### Requirements

* A Mars or Earth sized terrestrial planet

* 1.35e18 metric tonnes of water

* 3210 gigatonnes of carbon dioxide

### Setup Instructions

1. Find a planet satisfying the above requirements

2. Clone terraformly Python package via `git clone git@github.com:riverma/terraformly.git`

### Run Instructions

1. Navigate to the directory where terraformly is installed, i.e. `terraformly`

2. Run Python code, by first opening a terminal window

```

cd terraformly

python terraformly.py

```

5. Wait approximately 100 years

6. See example output in screenshot at the top of this README

### Usage Examples

#### Terraforming Mars

```

python terraformly.py --label Mars --planet-type terrestrial --surface-area 55.91 --surface-area-units million-sq-miles

```

Expected results:

```

Working...

(192 years later)

Done.

```

#### Terraforming Luna

```

python terraformly.py --label Luna --planet-type moon --surface-area 38 --surface-area-units million-sq-km

```

Expected results:

```

Sorry. Not enough water present for terraforming.

```

## Changelog

See [CHANGELOG](https://github.com/riverma/terraformly/blob/main/CHANGELOG.md) for details.

## Frequently Asked Questions (FAQ)

1. How long does terraformly take to run?

   - A few seconds to launch, but approximately 100 years for a Mars sized planet. Results vary by terrain and geological conditions.

2. Does terraformly work on moons without water?

   - No, as mentioned in the requirements, 1.35e18 metric tonnes of water are required to run terraformly.

## Contributing

See our [CONTRIBUTING.md](CONTRIBUTING.md) guide.

## License

See our [LICENSE](LICENSE). 

## Support

[@riverma](https://github.com/riverma)