Skip to content
This repository has been archived by the owner on Jul 11, 2024. It is now read-only.

Commit

Permalink
Add documentation webpage and configure docusaurus (#27)
Browse files Browse the repository at this point in the history 
* Add documentation webpage and update docusaurus config

* Add docum Tutorialsge and uate docusaurus config

* Add Tutorials page and update docusaurus config

* update tutorial route

* refactor tutorial code
  • Loading branch information
@allgandalf
allgandalf authored Sep 24, 2023
1 parent 58f35ec commit 3856e61
Show file tree
Hide file tree
Showing 4 changed files with 333 additions and 8 deletions.
19 changes: 11 additions & 8 deletions docusaurus.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,18 @@ module.exports = {
label: "Documentation",
position: "left",
items: [
{ to: "/documentation/master", label: "Master" },
{
to: "/documentation/develop",
label: "Develop",
to: "/documentation", label: "Documentation",
},
{
to: "/documentation/master", label: "Package Documentation",
},
{
to: "/tutorials", label: "Tutorials",
},
{
to: "http://pecan.ncsa.illinois.edu/pecan/01-introduction.php", label: "Demo"
},
],
},
{ to: "/blog", label: "Blog", position: "left" },
Expand Down Expand Up @@ -87,12 +94,8 @@ module.exports = {
],
},
{
title: "More",
title: "Contribute to Code",
items: [
{
label: "Google",
to: "/google",
},
{
label: "GitHub",
href: "https://github.com/PecanProject",
Expand Down
10 changes: 10 additions & 0 deletions src/pages/News.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@


}

.tutorial-container {
display: flex;
flex-direction: column;
align-items: center;
justify-content: center; /* Change from 'flex-start' to 'center' */
margin: 0 auto;
padding: 2rem;
max-width: 800px; /* Adjust the max-width as needed */
}


/* Media query for screens with a maximum width of 600px */
Expand Down
173 changes: 173 additions & 0 deletions src/pages/documentation.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
import React from "react";
import Layout from "@theme/Layout";
import styles from "./about.module.css";
import clsx from "clsx";
function gsoc() {
return (
<Layout title="documentation">
<div className={styles.aboutContainer}>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Latest Release Documentation</h3>
</div>
<div class="card__body">
<p>
<a href="documentation/master" class="text-size-20 text-m-size-16" ><u>Documentation consistent with latest release (MASTER BRANCH).</u></a>
</p>
</div>
</div>
</div>
</div>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-30 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Latest Code Documentation</h3>

</div>
<div class="card__body">
<p>
<a href="documentation/develop" class="text-size-20 text-m-size-16" ><u>Documentation consistent with latest stable code (DEVELOP BRANCH).</u></a>
</p>
</div>
</div>
</div>
</div>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Release V1.7.1</h3>

</div>
<div class="card__body">
<p>
<a href="https://pecanproject.github.io/pecan-documentation/v1.7.1" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.7.1</u></a>
</p>
</div>
</div>
</div>
</div>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Release 1.7.0</h3>

</div>
<div class="card__body">
<p>
<a href="https://pecanproject.github.io/pecan-documentation/1.7.0" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.7.0</u></a>
</p>
</div>
</div>
</div>
</div>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Release V1.6.0</h3>

</div>
<div class="card__body">
<p>
<a href="https://pecanproject.github.io/pecan-documentation/v1.6.0" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.6.0</u></a>
</p>
</div>
</div>
</div>
</div>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Release V1.5.3</h3>

</div>
<div class="card__body">
<p>
<a href="https://pecanproject.github.io/pecan-documentation/v1.5.3" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.5.3</u></a>
</p>
</div>
</div>
</div>
</div>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>


<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Release V1.5.1</h3>

</div>
<div class="card__body">
<p>
<a href="https://pecanproject.github.io/pecan-documentation/v1.5.1" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.5.1</u></a>
</p>
</div>
</div>
</div>
</div>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>


<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Release V1.5.0</h3>

</div>
<div class="card__body">
<p>
<a href="https://pecanproject.github.io/pecan-documentation/1.5.0" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.5.0</u></a>

</p>
</div>
</div>
</div>
</div>

<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Release V1.4.10.1</h3>

</div>
<div class="card__body">
<p>
<a href="https://pecanproject.github.io/pecan-documentation/1.4.10.1/" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.4.10.1</u></a>
</p>
</div>
</div>
</div>
</div>



</div>
</Layout>
);
}

export default gsoc;
139 changes: 139 additions & 0 deletions src/pages/tutorials.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
import React from "react";
import Layout from "@theme/Layout";
import "./News.css"; // Import your CSS file for styling

function Tutorials() {
return (
<Layout title="tutorials">
<div className="tutorial-container">
<div id="main_content_wrap" className="tutorial-container" >

<h1>
<a name="background" class="anchor" href="#background"><span class="octicon octicon-link"></span></a>Hands On Demos:</h1>

<div>PEcAn Tutorial v1.5.2
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="https://pecanproject.github.io/pecan-documentation/tutorials/Demo01.html" target="_blank" rel="nofollow">Tutorial 1</a>
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="https://pecanproject.github.io/pecan-documentation/tutorials/Demo02.html" target="_blank" rel="nofollow">Tutorial 2</a>
</div>
<div><br /></div>


<div>PEcAn Tutorial v1.5.0
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="https://pecanproject.github.io/pecan-documentation/tutorials/Demo01.html" target="_blank" rel="nofollow">Tutorial 1</a>
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="https://pecanproject.github.io/pecan-documentation/tutorials/Demo02.html" target="_blank" rel="nofollow">Tutorial 2</a>
</div>
<div><br /></div>

<div><a href="https://github.com/PecanProject/pecan/tree/v1.4.10.1/documentation/tutorials">PEcAn Tutorials v1.4.10</a></div>
<div><br /></div>


<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.1.4.8.1.pdf" target="_blank" rel="nofollow">PEcAn Tutorial v1.4.8</a>&nbsp; &nbsp; &nbsp; &nbsp;
<a href="https://github.com/PecanProject/pecan/tree/v1.4.8/documentation/tutorials" target="_blank" rel="nofollow">Additional Tutorials</a>
</div>
<div><br /></div>




<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.1.4.7.pdf" target="_blank" rel="nofollow">PEcAn Tutorial v1.4.7</a>&nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://people.bu.edu/dietze/documents/ParameterAssimilation.1.4.7.v2.pdf" target="_blank" rel="nofollow">Param DA</a>
</div>
<div><br /></div>

<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.1.4.6.docx" target="_blank" rel="nofollow">PEcAn Tutorial v1.4.6</a>
</div>
<div><br /></div>

<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.1.4.5.docx" target="_blank" rel="nofollow">PEcAn Tutorial v1.4.5</a>
</div>
<div><br /></div>

<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.1.4.3.pdf" target="_blank" rel="nofollow">PEcAn Tutorial v1.4.3</a>&nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://people.bu.edu/dietze/documents/ParameterAssimilation.1.4.3.pdf" target="_blank" rel="nofollow">Param DA</a>
</div>
<div><br /></div>

<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.1.4.2.docx" target="_blank" rel="nofollow">PEcAn Tutorial v1.4.2</a>
</div>
<div><br /></div>

<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.1.4.0.pdf" target="_blank" rel="nofollow">PEcAn Tutorial v1.4.0</a>
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://people.bu.edu/dietze/documents/PEcAn_New_User_Survey.v2.docx" target="_blank" rel="nofollow">Survey</a>
</div>
<div><br /></div>

<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.v8.pdf" target="_blank" rel="nofollow">PEcAn Tutorial v1.3.7</a>
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://people.bu.edu/dietze/documents/PEcAn_New_User_Survey.v2.docx" target="_blank" rel="nofollow">Survey</a>
</div>
<div><br /></div>

<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.v8.pdf" target="_blank" rel="nofollow">PEcAn Tutorial v1.3.6</a>
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://people.bu.edu/dietze/documents/PEcAn_New_User_Survey.v2.docx" target="_blank" rel="nofollow">Survey</a>
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://people.bu.edu/dietze/documents/ParameterAssimilation.1.3.6.pdf" target="_blank" rel="nofollow">Param DA</a>
&nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://people.bu.edu/dietze/documents/StateAssimilation.1.3.6.pdf" target="_blank" rel="nofollow">State DA</a>
</div>
<div><br /></div>
<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.v7.pdf" target="_blank" rel="nofollow">PEcAn Tutorial v1.3.4</a></div>
<div><br /></div>
<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.v6.pdf" rel="nofollow">PEcAn Tutorial v1.3.2</a><br /></div>
<div><br /></div>
<div><a href="http://people.bu.edu/dietze/documents/PEcAn_Demo_Handout.v5.pdf" target="_blank" rel="nofollow">PEcAn Tutorial</a> v1.3.0</div>
<div><br /></div>
<div><div></div><a href="https://docs.google.com/file/d/0BwrHpgWSpMHeOUZUZDNiSFoxSk0/edit">PEcAn Tutorial</a> v1.2.6<br /></div>

<h1 class="text-size-40 text-m-size-30 text-center">
<a name="pecans-approach" class="anchor" href="#pecans-approach"><span class="octicon octicon-link"></span></a>Vignettes:
</h1>

<h3 class="text-size-20 text-m-size-16 text-center">R Packages</h3>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/allometry/vignettes/AllomVignette.Rmd">Allometries</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/assim.batch/vignettes/AssimBatchVignette.Rmd">MCMC </a> - in development</div>

<div><a href="https://github.com/PecanProject/pecan/tree/master/modules/data.atmosphere/vignettes">Meteorology Data</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/meta.analysis/vignettes/single.MA_demo.Rmd">Meta-Analysis</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/photosynthesis/vignettes/ResponseCurves.Rmd">Photosynthetic response curves</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/priors/vignettes/priors_demo.Rmd">Priors</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/rtm/vignettes/pecanrtm.vignette.Rmd">Leaf spectra: PROSPECT inversion</a></div>

<h3>Concepts</h3>

<div><a href="https://github.com/PecanProject/pecan/tree/master/documentation/tutorials/sensitivity/PEcAn_sensitivity_tutorial_v1.0.Rmd">Model-Data Fusion: Univariate calibration 'by hand'</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/documentation/tutorials/MCMC/MCMC_Concepts.Rmd">Model-Data Fusion: MCMC</a></div>

<h1>
<a name="pecans-approach" class="anchor" href="#pecans-approach"><span class="octicon octicon-link"></span></a>Video:</h1>

{/* <!--<div>In 2012 PEcAn was used in an educational setting at two different summer short courses, PalEON's "Assimilating Long-Term Data into Ecosystem Models" week-long summer course" and the Niwot Ridge flux course ""Summer Course in Flux Measurements and Advanced Modeling". PEcAn was also used at the Ecosystem Demography Model training workshop at Harvard University in January 2012.</div>
<div><br /></div> --> */}

<h4>Flux Course 2012: PEcAn Tutorial</h4>

<section id="main_content" class="inner">

<iframe width="560" height="315" src="//www.youtube.com/embed/S_y6SnO7Hbw" frameborder="0" allowfullscreen></iframe>

</section>
</div>
</div>
</Layout>
);
}

export default Tutorials;

0 comments on commit 3856e61

Please sign in to comment.