Move website build #354
Move website build #354
Conversation
landinjm
force-pushed
the
move_website_build
branch
from
594944a to
a2efc7a
Compare
|
Is there a way that I can preview the site? |
|
Pull branch and follow instructions in doc/README.md You can open up doc/doxygen/html/index.html in any browser to view the website. I didn't spend much time making the site look pretty, so if you have suggestions please list them here |
| Git will then download the PRISMS-PF source code into a directory entitled ''phaseField''. A resource for learning to use Git can be found [here](https://git-scm.com/book). | ||
|
|
||
| If you prefer not to use Git, a zip file containing the PRISMS-PF source code can be downloaded [here](https://github.com/prisms-center/phaseField/releases). | ||
|
|
There was a problem hiding this comment.
Add instructions to checkout latest version.
There was a problem hiding this comment.
Lowish priority since I know you just want this out, but it is probably worth it to redo this page and make it a bit more hand-holdey at some point. Also make certain methods 'recommended' or 'not recommended'.
|
|
||
| A directory for each of these apps can be found in the [applications directory](https://github.com/prisms-center/phaseField/tree/master/applications) (i.e. phaseField/applications). The apps contain a formulation file giving the governing equations. In addition to the 24 apps listed above, some app names may be preceded by an underscore. The underscore is used to denote apps that are still under active development. | ||
|
|
||
| ## Compiling and Running the Allen-Cahn Example App |
There was a problem hiding this comment.
At some point before this, hyperlink to install_prismspf
There was a problem hiding this comment.
I haven't visualized the site yet. Im guessing this already exists in a sidebar.
| $ mpirun -n 1 main | ||
| ``` | ||
|
|
||
| ## Running in Release Mode and with Multple Processors |
There was a problem hiding this comment.
Release is default now?
| # Tests {#tests} | ||
| The 'tests' folder in the root directory contains some tests to ensure that PRISMS-PF is working properly. A battery of automated tests can be found in the 'automated_tests' directory. These can be run by running the python script 'run_automatic_tests.py'. This will run a series of unit and regression tests, printing a summary of the results to the screen and writing to the file 'test_results.txt'. This python file can also be used as an example of automating PRISMS-PF simulations. | ||
|
|
||
| The 'unit_tests' directory contains a driver for a series of unit tests. To run them enter: |
|
|
||
| The following section [The Parameters File](#input_file) will discuss the structure and options for the input file, parameters.prm. Users who do not need to change the governing equations or make other fundamental changes to the application will only need to modify this file. | ||
|
|
||
| [The App Files](#app_files) discusses the structure of the files that define an application: equations.cc, ICs_and_BCs.cc, postprocess.cc, nucleation.cc, customPDE.h. Users who want to substantially modify existing PRISMS-PF applications or create their own will find this section useful. |
There was a problem hiding this comment.
customPDE.h should be first or second in this list
There was a problem hiding this comment.
add a small section outlining what to change in cmakelists if additional .cc files are added (something like add_executable(main.cc customfile.cc))
doc/doxygen/landing_page.md
Outdated
There was a problem hiding this comment.
May be redundant to a link on the sidebar, but I would suggest a big hyperlink labeled "Getting Started" that links to the install page.
| ### setInitialCondition | ||
| Here's a look at the setInitialCondition function for the coupled Allen-Cahn/Cahn-Hilliard example application: | ||
| ``` | ||
| template <int dim, int degree> |
There was a problem hiding this comment.
do you want to leave in the [[maybe unused]] changes. Or any other template changes i may have missed.
| } | ||
| ``` | ||
|
|
||
| ## customPDE.h |
There was a problem hiding this comment.
I think this should be first
|
|
||
| The number and order of the entries for the elastic constants are (where \f$C_{ij}\f$ are entries in the stiffness matrix): | ||
|
|
||
| - ISOTROPIC (2D/3D): 2 constants (Young's Modulus, Poisson's Ratio) |
There was a problem hiding this comment.
im going to assume this stuff renders properly on the website
|
These comments can be addressed in the future. |
Description
Added github actions to build doxygen documentation and move it to gh-pages.