Skip to content

An entirely fake project to demonstrate repository best practices.

License

Notifications You must be signed in to change notification settings

riverma/terraformly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Terraformly

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

Contributor Covenant

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 | Discussion Board | Issue Tracker

Features

  • Terraform a terrestrial planet in seconds
  • Generate logs of terraforming actions completed
  • Future-proof terraforming for long-lasting results

Contents

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 [email protected]: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
  1. Wait approximately 100 years
  2. 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 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 guide.

License

See our LICENSE.

Support

@riverma

About

An entirely fake project to demonstrate repository best practices.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages