Skip to content

Commit

Permalink
Editing README
Browse files Browse the repository at this point in the history
  • Loading branch information
dmorse committed Jul 25, 2023
1 parent b3dc925 commit 836c064
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# PSCF - Polymer Self-Consistent Field Theory
# PSCF - Polymer Self-Consistent Field Theory (Fortran)

Copyright (2002-2017) Regents of the University of Minnesota

Expand All @@ -7,16 +7,16 @@ field theory (SCFT) for spatially periodic structures formed by block
copolymer melts and mixtures of block copolymers with linear
homopolymers and/or small molecule solvents.

# History: Legacy and Current Versions
## History and Versions

The version of PSCF provided here is a legacy version that was written
in Fortran 90. The current version of PSCF is a C++/CUDA package that
is available in a separate github repository at
in Fortran 90. The current version of PSCF is a rewritten C++/CUDA
package that is available in a separate github repository at
https://github.com/dmorse/pscfpp

Almost all of the features of this legacy Fortran version have been
ported to the current C++/CUDA version of PSCF, which also provides
some important new features. The home page for PSCF, which provides
several important new features. The home page for PSCF, which provides
a discussion of the differences between the two versions and links
to both is available at https://pscf-home.cems.umn.edu

Expand All @@ -31,13 +31,13 @@ it under the terms of the GNU General Public License as published by
the Free Software Foundation. A copy of this license is included in
the LICENSE file in the top-level PSCF directory.

# Dependencies
## Dependencies

This version of PSCF depends upon the FFTW fast Fourier transform library
and the LAPACK linear algebra library. These packages must be installed
before attempting to compile the program from source.

# User Documentation
## User Documentation

A web user manual is available at https://pscf.readthedocs.io

Expand All @@ -54,14 +54,14 @@ introduction to SCFT, discusses some of the algorithms and file formats
used in the PSCF program, and discusses some issues and questions faced
by first time users.

# Developer Documentation
## Developer Documentation

A local copy of the developer API documentation, which includes
documentation for all modules, subroutines and public variables, may
be regenerated by following instructions given in the file doc/README.
The resulting html pages are installed in the doc/devel-man directory.

# Reference Article
## Reference Article

If you use either version of PSCF in published work, we request that you
cite the paper:
Expand All @@ -74,12 +74,12 @@ G.H. Fredrickson, F.S. Bates and K.D. Dorfman,
available electronically at
http:https://pubs.acs.org/doi/10.1021/acs.macromol.6b00107

# Examples
## Examples

A library of examples is provided in a separate github repository,
located at https://github.com/dmorse/pscf-examples

# Links
## Links

- Home Page: https://pscf-home.cems.umn.edu/
- Source Code: https://github.com/dmorse/pscf
Expand All @@ -92,7 +92,7 @@ located at https://github.com/dmorse/pscf-examples

[![Travis][buildstatus_image_travis]][travisci]

# Repository Directory Structure
## Repository Directory Structure

src/ - Fortran 90 source files
doc/ - documentation files
Expand All @@ -106,7 +106,7 @@ An annotated list of source files is given in the file src/SRC_FILES.
Before modifying any fortran files, see the note at the end of that
file regarding the use of preprocessor to generate some files.

# Contributors
## Contributors

- David Morse
- Chris Tyler
Expand All @@ -115,7 +115,7 @@ file regarding the use of preprocessor to generate some files.
- Raghuram Thiagarajan
- Akash Arora

# Support
## Support

Development of this Fortran version of PSCF has been supported by
National Science Foundation grants NSF-DMR097338 and NSF-DMR130436.

0 comments on commit 836c064

Please sign in to comment.