DataChallenge
A repository for DeepLearnPhysics group DataChallenge webpage for public data descriptions.
The master
branch holds static HTML files generated by Pelican with freeagent.
The develop
branch holds source code to generate the website.
Requirement
You need python packages:
pelican >= 3.5.0
markdown >= 2.6.9
How to contribute (develop)
For aweome you to help development, follow the following steps. I split into three steps: installation, compilation, development, and publish.
Installation
- Join web-blog github team
- Clone the repo:
git clone git@github.com:DeepLearnPhysics/DataChallenge
. - Make sure you are on the
develop
branch bygit branch
Compilation
By compilation we mean to generate static HTMLs. This is fairly simple:
make html
Development
Our development work is a process of modify-compile-check. The first to-do is:
- Open
pelicanconf.py
and uncomment the line#SITEURL = ''
. This generates HTMLs to be viewed locally. make devserver
then accesslocalhost:8000
on your browser. This runs a virtual pelican web server on your machine and allows you to browse the updated website contents all on your laptop.- Make modifications you wish to make.
contents
directory is where you make a blog post. make html
will update your local static website.
Publish
After you finish your development work, if you want to publish your change on our website, you have to push your changes.
- Open
pelicanconf.py
and comment out the lineSITEURL = ''
. This generates HTMLs to be viewed on the shared remote server. make html
and if you are running a local virtual server,make stopserver
.- Commit your changes to the develop branch.
git checkout master
... the master branch holds static website contents.cp -r output/* ./
git add .
git commit -m "your message"
git push
Done!
Copyright and license
It is under the MIT license.