Comments (5)
hdrake
commented on June 19, 2024
I've got a proof-of-concept of this working at https://github.com/hdrake/MARGO.jl/tree/documenting, following the step-by-step Documenter.jl guide, but haven't yet deployed it as a standalone github page.
from climatemargo.jl.
hdrake
commented on June 19, 2024
Planning on adding the bare minimum of documentation to #28 before releasing v0.1.0.
- Landing page
- Installation instructions
- A basic example
- Guide for contributors
- Description of model parameters (by submodule)
- Optimization process
- How to use the diagnostic functions
from climatemargo.jl.
hdrake
commented on June 19, 2024
Added some auto-generating docs in #33 with Literate.jl, which turns a basic .jl julia script fill with special comment formatting into a beautiful .md document with code cells and ouputs (including figures!).
from climatemargo.jl.
hdrake
commented on June 19, 2024
Need to be updated to be consistent with the published version of the model!
Edit: As of v0.3.2, the documentation is once again consistent with the model.
from climatemargo.jl.
fonsp
commented on June 19, 2024
The plotting functions still need to be listed
from climatemargo.jl.
Related Issues (20)
- Coherent & concise JuMPification of MARGO? HOT 7
- Consistent mitigation costs HOT 1
- Consistent and correct methods for changing the timestep on the fly. HOT 8
- Add optimization constraints as a submodel in ClimateModel or ClimateModelParameters? HOT 1
- Implement exact solution to two-box energy balance model HOT 2
- Towards a generic MARGO model structure (with abstract submodel types) HOT 1
- Add costs attributed to emissions (e.g. air pollution on human health) and CO2 (e.g. ocean acidification) HOT 3
- Inconsistency about whether `t.==present_year` should be included in `future_mask`. HOT 1
- Moving to ClimateMARGO github organization HOT 3
- TagBot trigger issue HOT 22
- Problems with T_adapt and optimization in 0.2.0 HOT 2
- Stochastic optimization
- Replace PyPlot calls with Plots.jl HOT 5
- Replace "tutorial.ipynb" with a Literate.jl script HOT 1
- Inconsistent naming "M" and "mitigate", nested and flat, struct and Dict HOT 4
- "How do I extract ClimateMARGO.jl data as a csv file?" HOT 4
- Experiment with converting to NLopt instead of JuMP
- Include example of the "policy response process" described in paper HOT 1
- What new feature or storyline would you like to see?
- Multiple equilibria HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from climatemargo.jl.