tjfulle / matmodlab

Generalized material model driver
9 stars 4 forks source link

'mml fetch' is incomplete #5

Closed sswan closed 9 years ago

sswan commented 9 years ago

Opening an issue for an incomplete feature so that we don't forget about it:

commit 342d5f6548e26da12ca7f3aa43f2b5e1304c7d07 Author: Tim Fuller timothy.fuller@me.com Date: Thu Sep 10 10:04:39 2015 -0600

An update to Scot's commit of grabbing the examples directory (which
I loved).

OVERVIEW:

The examples mml subcommand was replaced by fetch.  The previous
behavior is now

    mml fetch examples

mml fetch does a few other things:

o get copy of the tests

    mml fetch tests

o get copy of the documentation

    mml fetch documentation

o get a copy of a file in the examples directory:

    mml fetch filename

The last command should be updated to not only get the filename, but
also any resources required by the file (for example, an example file
that runs a umat should also get the umat).
sswan commented 9 years ago

I was looking at the code for the 'mml fetch documentation' and noticed that it assumes that you did a 'python setup.py develop'. This would not work for people that do 'pip install matmodlab'. Perhaps we should move the documentation into the actual master branch?

tjfulle commented 9 years ago

You're right - it does assume a git clone. I hadn't thought about other options... Rats. Unfortunately, for the github pages to work, the documentation must be in a gh-pages branch. To have it in the master branch is a mess. Maybe, instead, a releasable pip version with the documentation included can be worked out?

tjfulle commented 9 years ago

Fetch now checks that the .git directory exists before fetching documentation