Permalink
Browse files

generalize

  • Loading branch information...
1 parent a9d2ef2 commit fd80aaf1859ac08aa7fedad83a93c1175d58f299 @seamusabshere seamusabshere committed Aug 4, 2011
View
@@ -2,6 +2,7 @@ gem 'emitter', :path => ENV['LOCAL_EMITTER'] if ENV['LOCAL_EMITTER']
gem 'sniff', :path => ENV['LOCAL_SNIFF'] if ENV['LOCAL_SNIFF']
gem 'earth', :path => ENV['LOCAL_EARTH'] if ENV['LOCAL_EARTH']
gem 'data_miner', :path => ENV['LOCAL_DATA_MINER'] if ENV['LOCAL_DATA_MINER']
+gem 'leap', :path => ENV['LOCAL_LEAP'] if ENV['LOCAL_LEAP']
gem 'force_schema', :path => ENV['LOCAL_FORCE_SCHEMA'] if ENV['LOCAL_FORCE_SCHEMA']
source :rubygems
View
@@ -1,21 +1,21 @@
BRIGHTER PLANET ADDITIONAL PREAMBLE TO THE GNU AFFERO GENERAL PUBLIC LICENSE
-January 7, 2011
+August 3, 2011
This preamble is meant to help the licensee understand exactly what
software is being received under the license and set expectations as to
what is not covered.
IDENTITY OF THE SOFTWARE MODULE COVERED BY LICENSE:
-This license covers the Brighter Planet carbon model referred to as
+This license covers the Brighter Planet impact model referred to as
'Flight,' officially distributed from
https://github.com/brighterplanet/flight.
SCOPE OF THE SOFTWARE MODULE COVERED BY LICENSE:
The scope of the license includes only those files included in the
-official Brighter Planet distribution package for the particular carbon
-model identified above, including only the carbon model execution files,
+official Brighter Planet distribution package for the particular impact
+model identified above, including only the impact model execution files,
reference data classes, input characterization, fallbacks, summarization
helpers, tests, and test fixtures.
@@ -39,13 +39,14 @@ This license does not extend to the following:
license including but not limited to other forms of open source
license, commercial license, and the like;
- * Any element of any Brighter Planet Carbon Middleware web service,
+ * Any element of any Brighter Planet CM1 web service,
including but not limited to the copyrights, trademarks, graphic
design, text, documentation, method of interaction with clients,
runtime environment, technical infrastructure, and software code, is
not covered by the license; and
- * Any aspect or use of http://carbon.brighterplanet.com.
+ * Any aspect or use of http://carbon.brighterplanet.com or any
+ subdomain of brighterplanet.com.
If you have any questions, please contact licensing@brighterplanet.com
View
@@ -1,12 +1,12 @@
# Flight
-The flight gem is used by Brighter Planet's Carbon Middleware platform to define a mathematical emissions model for a flight on any airline or aircraft. In addition, this gem defines how the model's calculation is displayed in a human readable format.
+The flight gem is used by Brighter Planet's CM1 web service to define a mathematical impacts model for a flight on any airline or aircraft. In addition, this gem defines how the model's calculation is displayed in a human readable format.
Contributions are welcome and encouraged, as we believe that help from the scientific and developer communities will help us provide correct and transparent models of greenhouse gas-emitting activities. See the section on the Collaboration Cycle below.
## Usage
-The flight gem defines a module, BrighterPlanet::Flight that should be included into an ActiveRecord model. Calling #emission on an instance of the model will determine the amount of emissions (CO2e) generated by the activity.
+The flight gem defines a module, BrighterPlanet::Flight that should be included into an ActiveRecord model. Calling #impact on an instance of the model will determine the amount of impacts (CO2e) generated by the activity.
class FlightRecord < ActiveRecord::Base
@@ -15,7 +15,7 @@ The flight gem defines a module, BrighterPlanet::Flight that should be included
end
f = FlightRecord.new :origin_airport => { :iata_code => 'DTW'}, :destination_airport => { :iata_code => 'SFO' }
- f.emission
+ f.impact.carbon
@rossmeissl

rossmeissl Aug 4, 2011

Owner

Should be f.impact[:carbon]

# => 2472
## Getting Ready for Development
@@ -33,10 +33,10 @@ Included in the repository is a .rvmrc that will automatically create a ruby 1.8
## Testing
-Our goal is to have sufficient testing coverage for our emissions models. We have chosen to write our tests using [cucumber](http://cukes.info) as the table-formatted testing fits well with our calculations tests and the plain English stories lower the barrier to entry for programmers of all skill levels.
+Our goal is to have sufficient testing coverage for our impacts models. We have chosen to write our tests using [cucumber](http://cukes.info) as the table-formatted testing fits well with our calculations tests and the plain English stories lower the barrier to entry for programmers of all skill levels.
There are two main features:
-* flight_emissions.feature, which tests emission values for various inputs
+* flight_impacts.feature, which tests impact values for various inputs
* flight_committees.feature, which tests sub-calculations used within the model
To run all tests: `rake` or `cucumber`
@@ -53,7 +53,7 @@ See: [https://github.com/brighterplanet/sniff](https://github.com/brighterplanet
### Earth
-The earth gem contains the model definitions for dependent data models. For instance, this is zip code data or fuel prices used in the emissions calculations. Earth will look for any test fixtures defined in lib/test_support/db/fixtures. These sample records are in csv format and are imported into the testing database.
+The earth gem contains the model definitions for dependent data models. For instance, this is zip code data or fuel prices used in the impacts calculations. Earth will look for any test fixtures defined in lib/test_support/db/fixtures. These sample records are in csv format and are imported into the testing database.
## Implementation
Oops, something went wrong.

0 comments on commit fd80aaf

Please sign in to comment.