Giter Club home page Giter Club logo

juliachem.jl's Introduction

Build Status codecov

Welcome to JuliaChem.jl!

JuliaChem.jl is an electronic structure theory program written in Julia, designed to combine Julia's dynamic and interactive nature with its high-performance capabilities to offer users the best of both worlds for quantum chemistry computations.

If you would like to read more about JuliaChem.jl, refer to the following paper:

Poole, D.; Galvez Vallejo, J. L.; and Gordon, M. S. "A New Kid on the Block: Application of Julia to Hartree-Fock Calculations". J. Chem. Theory Comput. 2020, 16(8), 5006-5013.

Building JuliaChem (for Users)

If you are simply interested in using JuliaChem.jl for your calculations, you can build JuliaChem.jl as follows:

Pkg.add(PackageSpec(url="https://github.com/davpoolechem/JuliaChem.jl.git"))

This will download the JuliaChem.jl package to your computer and build the Libint/JuliaChem.jl interface. If all goes well, this should be all that is needed. Now, you can use JuliaChem.jl in any script you wish simply by importing the JuliaChem.jl module:

using JuliaChem

Building JuliaChem (for Developers)

If you are interested in actively developing JuliaChem.jl, you will want to build and install JuliaChem.jl as follows.

  1. Git clone the JuliaChem.jl repo into your directory and cd into it.

  2. Next, JuliaChem.jl itself can be set up for development. This can be done in the Julia REPL by first pushing the ] button on your keyboard, and then inputting the following command into the REPL:

dev .
  1. Finally, JuliaChem.jl needs to be built. This can be done by inputting the following command into the Julia REPL:
build JuliaChem

This will build both the JuliaChem.jl package and the corresponding Libint/JuliaChem.jl interface. If all goes well, this should be all that is needed. Now, you can use JuliaChem.jl in any script you wish simply by importing the JuliaChem.jl module:

using JuliaChem

Documentation

JuliaChem.jl uses the Documenter.jl package to allow for the generation of its documentation. Much of the information regarding JuliChem, its usage, and its inner workings is contained within the documentation. The documentation is generated by going into the docs/ directory and running

julia make_user.jl

in the shell.

juliachem.jl's People

Contributors

zlatanvasovic avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.