Merge pull request #9 from lrennels/registry

Various fixes for consistency with registry

.travis.yml

@@ -2,15 +2,14 @@ language: julia
 os:
   - linux
 julia:
-  - 1.0
+  - 1.1
 notifications:
   email: false
 before_install:
   - julia -e 'using Pkg; Pkg.add("Distributions")'
   - julia -e 'using Pkg; Pkg.add("CSVFiles")'
   - julia -e 'using Pkg; Pkg.add("DataFrames")'
   - julia -e 'using Pkg; Pkg.add("StatsBase")'
-
   - julia -e 'using Pkg; Pkg.add("Mimi")'
 script:
   - julia test/runtests.jl

README.md

@@ -22,25 +22,41 @@ FUND was originally developed by Richard Tol. It is now co-developed by David An
 
 The minimum requirement to run FUND is [Julia](http://julialang.org/) and the [Mimi](https://github.com/davidanthoff/Mimi.jl) package. To run the example IJulia notebook file you need to install [IJulia](https://github.com/JuliaLang/IJulia.jl).
 
-### Installing Julia
+### Software Requirements
 
-You can download Julia from [http://julialang.org/downloads/](http://julialang.org/downloads/). You should use the v0.6.x version and install it.
+You need to install [Julia 1.1.0](https://julialang.org) or newer to run this model.  You can download Julia from [http://julialang.org/downloads/](http://julialang.org/downloads/).
 
-### Installing the Mimi package
+### Preparing the Software Environment
 
-Start Julia and enter the following command on the Julia prompt:
+You first need to connect your julia installation with the central Mimi registry of Mimi models. This central registry is like a catalogue of models that use Mimi that is maintained by the Mimi project. To add this registry, run the following command at the julia package REPL:
 
-````julia
-Pkg.add("Mimi")
-````
+```julia
+pkg> registry add https://github.com/mimiframework/MimiRegistry.git
+You only need to run this command once on a computer.
+```
+
+The next step is to install MimiRICE2010.jl itself. You need to run the following command at the julia package REPL:
+
+```julia
+pkg> add MimiRICE2010
+```
+
+You probably also want to install the Mimi package into your julia environment, so that you can use some of the tools in there:
+
+```
+pkg> add Mimi
+```
 
 ### Keeping requirements up-to-date (optional)
 
 Many of these requirements are regularly updated. To make sure you have the latest versions, periodically execute the following command on the Julia prompt:
 
-````julia
-Pkg.update()
-````
+```julia
+pkg> up
+```
+## Running the model
+
+The model uses the Mimi framework and it is highly recommended to read the Mimi documentation first to understand the code structure. For starter code on running the model just once, see the code in the file `examples/main.jl`.
 
 ## Versions and academic use policy
 

examples/main.jl

@@ -0,0 +1,7 @@
+using Mimi
+using MimiFUND
+
+m = getfund()
+run(m)
+
+explore(m)

src/MimiFUND.jl

@@ -5,6 +5,11 @@ using DelimitedFiles #base.DelimitedFiles
 
 include("helper.jl")
 
+include("new_marginaldamages.jl")
+include("montecarlo/defmcs.jl")
+include("montecarlo/run_fund_mcs.jl")
+include("montecarlo/run_fund_scc_mcs.jl")
+
 include("components/SocioEconomicComponent.jl")
 include("components/PopulationComponent.jl")
 include("components/EmissionsComponent.jl")
@@ -36,7 +41,7 @@ include("components/ImpactAggregationComponent.jl")
 include("components/VslVmorbComponent.jl")
 
 export
-    getfund     # Function that returns a version of fund allowing for different user specifications
+    getfund # a function that returns a version of fund allowing for different user specifications
 
 
 const global default_nsteps = 1050

src/components/BioDiversityComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp biodiversity begin
+@defcomp biodiversity begin
     # Number of species
     nospecies = Variable(index=[time])
 

src/components/ClimateCH4CycleComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp climatech4cycle begin
+@defcomp climatech4cycle begin
     # Global CH4 emissions in Mt of CH4
     globch4 = Parameter(index=[time])
 

src/components/ClimateCO2CycleComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp climateco2cycle begin
+@defcomp climateco2cycle begin
     # Anthropogenic CO2 emissions in Mt of C
     mco2 = Parameter(index=[time])
 

src/components/ClimateDynamicsComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp climatedynamics begin
+@defcomp climatedynamics begin
     # Total radiative forcing
     radforc = Parameter(index=[time])
 

src/components/ClimateForcingComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-function interact(M, N)
+function interact(M, N)
     d = 1.0 + (M * N)^0.75 * 2.01E-5 + (M * N)^1.52 * M * 5.31E-15
     return 0.47 * log(d)
 end

src/components/ClimateN2OCycleComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp climaten2ocycle begin
+@defcomp climaten2ocycle begin
     # Global N2O emissions in Mt of N
     globn2o = Parameter(index=[time])
 

src/components/ClimateRegionalComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp climateregional begin
+@defcomp climateregional begin
     regions = Index()
     inputtemp = Parameter(index=[time])
     bregtmp = Parameter(index=[regions])

src/components/ClimateSF6CycleComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp climatesf6cycle begin
+@defcomp climatesf6cycle begin
     # Global SF6 emissions in kt of SF6
     globsf6 = Parameter(index=[time])
 

src/components/EmissionsComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp emissions begin
+@defcomp emissions begin
     regions = Index()
 
     mitigationcost = Variable(index=[time,regions])

src/components/GeographyComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp geography begin
+@defcomp geography begin
     regions = Index()
 
     area = Variable(index=[time,regions])

src/components/ImpactAggregationComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactaggregation begin
+@defcomp impactaggregation begin
     regions = Index()
 
     eloss = Variable(index=[time,regions])

src/components/ImpactAgricultureComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactagriculture begin
+@defcomp impactagriculture begin
     regions = Index()
 
     gdp90 = Parameter(index=[regions])

src/components/ImpactBioDiversityComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactbiodiversity begin
+@defcomp impactbiodiversity begin
     regions = Index()
 
     # Change in number of species in relation to the year 2000

src/components/ImpactCardiovascularRespiratoryComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactcardiovascularrespiratory begin
+@defcomp impactcardiovascularrespiratory begin
     regions = Index()
 
     basecardvasc = Variable(index=[time,regions])

src/components/ImpactCoolingComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactcooling begin
+@defcomp impactcooling begin
     regions = Index()
 
     cooling = Variable(index=[time,regions])

src/components/ImpactDeathMorbidityComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactdeathmorbidity begin
+@defcomp impactdeathmorbidity begin
     regions = Index()
 
     dead = Variable(index=[time,regions])

src/components/ImpactDiarrhoeaComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactdiarrhoea begin
+@defcomp impactdiarrhoea begin
     regions = Index()
 
     diadead = Variable(index=[time,regions])

src/components/ImpactExtratropicalStormsComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactextratropicalstorms begin
+@defcomp impactextratropicalstorms begin
     regions = Index()
 
     extratropicalstormsdam = Variable(index=[time,regions])

src/components/ImpactForestsComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactforests begin
+@defcomp impactforests begin
     regions = Index()
 
     forests = Variable(index=[time,regions])

src/components/ImpactHeatingComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactheating begin
+@defcomp impactheating begin
     regions = Index()
 
     heating = Variable(index=[time,regions])

src/components/ImpactSeaLevelRiseComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactsealevelrise begin
+@defcomp impactsealevelrise begin
     regions = Index()
 
     wetval = Variable(index=[time,regions]) # Valuation of wetlands

src/components/ImpactTropicalStormsComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impacttropicalstorms begin
+@defcomp impacttropicalstorms begin
     regions = Index()
 
     hurrdam = Variable(index=[time,regions])

src/components/ImpactVectorBorneDiseasesComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactvectorbornediseases begin
+@defcomp impactvectorbornediseases begin
     regions = Index()
 
     dengue = Variable(index=[time,regions])

src/components/ImpactWaterResourcesComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp impactwaterresources begin
+@defcomp impactwaterresources begin
     regions = Index()
 
     watech = Variable(index=[time])

src/components/OceanComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp ocean begin
+@defcomp ocean begin
     # Sea-level rise in meters
     sea = Variable(index=[time])
 

src/components/PopulationComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp population begin
+@defcomp population begin
     regions             = Index()
 
     population          = Variable(index=[time,regions])

src/components/ScenarioUncertaintyComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp scenariouncertainty begin
+@defcomp scenariouncertainty begin
     regions = Index()
 
     pgrowth = Variable(index=[time,regions])

src/components/SocioEconomicComponent.jl

@@ -1,6 +1,4 @@
-using Mimi
-
-@defcomp socioeconomic begin
+@defcomp socioeconomic begin
 	regions = Index()
 
 	income = Variable(index=[time,regions])

src/components/VslVmorbComponent.jl

@@ -1,5 +1,3 @@
-using Mimi
-
 @defcomp vslvmorb begin
     regions = Index()
 

src/components/scenconverter.jl

@@ -1,5 +1,3 @@
-using Mimi
-
 @defcomp scenconverter begin
     regions = Index()
 

src/marginaldamage3.jl

@@ -1,8 +1,3 @@
-using Mimi
-include("helper.jl")
-include("fund.jl")
-using .Fund 
-
 """
 Returns one default FUND model and one model with additional emissions of the specified gas in the specified year.
 """

src/marginaldamages.jl

@@ -1,8 +1,3 @@
-using Mimi 
-include("helper.jl")
-include("fund.jl")
-using .Fund 
-
 """
 Returns a matrix of marginal damages per one ton of additional emissions of the specified gas in the specified year.
 """

src/montecarlo/defmcs.jl

@@ -1,9 +1,8 @@
-using Mimi
 using Distributions
 
 function getmcs()
 
-    mcs = @defmcs begin
+    mcs = @defsim begin
 
         aceiadd = ["USA" => Normal(0.0,0.025), "CAN" => Normal(0.0,0.025), "WEU" => Normal(0.0,0.025), "JPK" => Normal(0.0,0.0375), "ANZ" => Normal(0.0,0.0375), "EEU" => Normal(0.0,0.025), "FSU" => Normal(0.0,0.025), "MDE" => Normal(0.0,0.0875), "CAM" => Normal(0.0,0.05625), "LAM" => Normal(0.0,0.05625), "SAS" => Normal(0.0,0.0875), "SEA" => Normal(0.0,0.0875), "CHI" => Normal(0.0,0.0375), "MAF" => Normal(0.0,0.11875), "SSA" => Normal(0.0,0.11875), "SIS" => Normal(0.0,0.05625)]
         aeeiadd = ["USA" => Normal(0.0,0.0625), "CAN" => Normal(0.0,0.0625), "WEU" => Normal(0.0,0.0625), "JPK" => Normal(0.0,0.0625), "ANZ" => Normal(0.0,0.0625), "EEU" => Normal(0.0,0.1), "FSU" => Normal(0.0,0.1), "MDE" => Normal(0.0,0.15), "CAM" => Normal(0.0,0.15), "LAM" => Normal(0.0,0.15), "SAS" => Normal(0.0,0.15), "SEA" => Normal(0.0,0.15), "CHI" => Normal(0.0,0.175), "MAF" => Normal(0.0,0.15), "SSA" => Normal(0.0,0.15), "SIS" => Normal(0.0,0.15)]