Skip to content

Commit

Permalink
Some minor updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
shyuep committed Jul 30, 2017
1 parent c615d3a commit 3c36c85
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ jobs:
pmg structure --convert --filenames POSCAR.pmg pmg.cif
pmg analyze -d test_files
no_output_timeout: 3600

workflows:
version: 2
build_and_test:
Expand Down
18 changes: 9 additions & 9 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<When reporting bugs/issues, please supply the following information. If
this is a feature request, please simply state the requested feature.>
When reporting bugs/issues, please supply the following information. If
this is a feature request, please simply state the requested feature.

## System

Expand All @@ -9,30 +9,30 @@ this is a feature request, please simply state the requested feature.>

## Summary

* <Short 1-2 bullet points stating the problem.>
* 1-2 short bullet points stating the problem.

## Example code

```python
<Example code generating error>
# Example code generating error
```

## Error message

```
<Error message>
# Error message
```

## Suggested solution (if any)

* <If you have a suggestion on how to solve the issue, you may write it
here.>
* If you have a suggestion on how to solve the issue, you may write it
here.

## Files (if any)

<If input files are needed to reproduce the error, please provide
* If input files are needed to reproduce the error, please provide
either links (e.g., Dropbox or GDrive) for large files or simply paste
the file below for small files.>
the file below for small files.

```
<contents of file 1>
Expand Down
17 changes: 8 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Summary

<Short few sentences, and summary of the major changes in bullet
points>
Short few sentences, and summary of the major changes in bullet
points

* Feature 1
* Feature 2
Expand All @@ -10,17 +10,16 @@ points>

## Additional dependencies introduced (if any)

<List all new dependencies needed. While adding dependencies that bring
* List all new dependencies needed. While adding dependencies that bring
significantly useful functionality is perfectly fine, adding ones that
add trivial functionality, e.g., to use one single easily implementable
function, is frowned upon. If you are putting anything here, you should
provide a justification why that dependency is needed. Especially
frowned upon are circular dependencies, e.g., depending on derivative
modules of pymatgen such as custodian or Fireworks.>
function, is frowned upon. Provide a justification why that dependency is needed.
Especially frowned upon are circular dependencies, e.g., depending on derivative
modules of pymatgen such as custodian or Fireworks.

## TODO (if any)

<If this is a work-in-progress, write something about what else needs
to be done>
If this is a work-in-progress, write something about what else needs
to be done

* Feature 1 supports a, but not b.
6 changes: 4 additions & 2 deletions docs_rst/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,12 +250,14 @@ Step 2: Install pymatgen in developmental mode
1. Make sure you have git and `git-lfs <https://git-lfs.github.com/>`_ installed.
Clone the repo at https://github.com/materialsproject/pymatgen.

2. In your root pymatgen repo directory, type (you may need to do this with root
2. Run `git lfs install` in the cloned repo first.

3. In your root pymatgen repo directory, type (you may need to do this with root
privileges)::

pip install -e .

3. Install any missing python libraries that are necessary.
4. Install any missing python libraries that are necessary.

I recommend that you start by reading some of the unittests in the tests
subdirectory for each package. The unittests demonstrate the expected behavior
Expand Down

0 comments on commit 3c36c85

Please sign in to comment.