usnistgov/pfhub

The CHiMaD Phase Field Community Website

^{PFHub: Phase Field Community Hub}

^{See the live website at pages.nist.gov/pfhub.}

Overview

PFHub is a location to compare and contrast phase field codes. See the main web site for more details. To develop or update the site, please see the Development Guide.

Deploy

Nix is excellent choice to get started with deploying this website. If you don't prefer Nix then use the Docker container.

Deploy Using Nix

To install an environment to run the website using Nix, consult the Nix Guide.

Deploy Using Docker

To install an environment to run the website using Docker, consult the Docker Guide.

Cite

If you use this website in your reseach, please see CITATION.cff and cite it as follows:

Wheeler, D., Keller, T., DeWitt, S. J., Jokisaari, A. M., Schwen, D., Guyer, J. E., Aagesen, L. K., Heinonen, O. G., Tonks, M. R., Voorhees, P. W., Warren, J. A. (2019). PFHub: The Phase-Field Community Hub. Journal of Open Research Software, 7(1), 29. DOI: http://doi.org/10.5334/jors.276

pfhub's Issues

Add some narrative

Include twitter feed

Create a small Flask app to generate the code data dynamically

front page never stops loading

Integrate with Depsy in some way

Depsy is a flask app that we could just fork or take code from
use the API

Run web site through a valid HTML checker

Implement Disqus at bottom of page

Clean up front page

• add narative
• clean up logo
• clean up navbar
• make navbar dynamic
• link to mailing list
• link to github
• fix up readme and include in front page
• make links go to new tab
• add in workshop details
• code blocks change color on hover and also go to home pages
• Disqus

Include description and documents about recent Hackathon

Automate code metadata updates

Add footer on front page

All links should open new tab

Typos and styling problems

• "unsubsribe" should be monofont on the "Mailing List" page

Switch to SASS

Add separate page for each code

Font differences between the Github deployment and localhost

The fonts look entirely different when pushed to Github compare with localhost

Create standard problem content

Just use a "phase field" tag on github to find codes rather than actually registering code

Use flexbox with the code blocks

Create Docker environment to run the preprocessing

Make the logo SVG

Generate simple procedure for uploading output data and code input files

• include documents that describe the problem specification
  • generate schema / method to capture environment and output

Contact repository admins to fix the meta data

Repositories are missing the correct meta data in some cases.

set up fipy docker instance with previous example problem

Disqus Comments

@wd15 are broken on the homepage

Possible to automate running the examples for each code?

Integrate with Google forms to produce YAML file of simulation data

Use Google Forms to enter the YAML data for simulations

Add mybinder.org example for FiPy code

http://app.mybinder.org/2545817461/notebooks/index.ipynb

Intergrate Twitter sidebar on front page

Increase size of images in the Hexbin

• [ ] increase size of images
• [ ] get more images

Remove pointless badges

• remove issues
  • remove pull-requests
  • remove build status

Build status is pointless and the issues and pull-requests are both pointless and broken most of the time.

Integrate with CORR to capture output and environment

Fix README to include full installation and requirements

Make materialize icons show on front page

Code Block Issues

• order the code blocks according to the data
• have only three numbers in the code blocks, too much data right now
• increase the transparency of the background color
• fix description message
• include logos for all the codes
• increase spacing between icons
• move icons below the header
• larger font

Create SVG version of Chimad logo

Create Python code to get Github data

Include FEniCS

Just use static data that's update when the site is built.

"

Add mailing list link and description

Host on AWS -- talk with Adam Morey

Include inception of codes

See http://article.gmane.org/gmane.comp.science.chimad-phase-field/4

Create Slack group or Gitter for chimad-phase-field

See http://www.slacklist.info/
Also try out gitter

Look into paper.li as a possible way to generate content

Add page on FiPy Docker image including output and relevant data as an example

Set home for MOOSE

The home for MOOSE can be set to mooseframework.org

Include FiPy results from Hackathon

Clean up the directories that are no longer required

It seems that _data and data are no longer required along with some other directories. Also maybe use the {{ data.*.* }} syntax to pass the data into the javascript rather than having the javascript read the datafiles.

Switch to Materialize

Ansible script to capture environment and simulation results