Metadata-Version: 2.4
Name: CFcal
Version: 0.1.7
Summary: Python calculator for crystal fields
Author-email: Raymond Osborn <rayosborn@mac.com>
License: Licensing Terms for NeXpy
        -------------------------
        
        NeXpy is licensed under the terms of the Modified BSD License (also known as
        New or Revised BSD), as follows:
        
        Copyright (c) 2017, Ray Osborn
        
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        Redistributions of source code must retain the above copyright notice, this
        list of conditions and the following disclaimer.
        
        Redistributions in binary form must reproduce the above copyright notice, this
        list of conditions and the following disclaimer in the documentation and/or
        other materials provided with the distribution.
        
        Neither the name of the NeXpy Development Team nor the names of its
        contributors may be used to endorse or promote products derived from this
        software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
        Copyright
        ---------
        
        The following banner should be used in any source code file to indicate the 
        copyright and license terms:
        
        #-----------------------------------------------------------------------------
        # Copyright (c) 2017, Ray Osborn.
        #
        # Distributed under the terms of the Modified BSD License.
        #
        # The full license is in the file COPYING, distributed with this software.
        #-----------------------------------------------------------------------------
        
Project-URL: Homepage, https://github.com/rayosborn/cfcal
Project-URL: Repository, https://github.com/rayosborn/cfcal.git
Project-URL: Issues, https://github.com/rayosborn/cfcal/issues
Project-URL: Documentation, https://github.com/rayosborn/cfcal
Project-URL: Changelog, https://github.com/rayosborn/cfcal/releases
Keywords: neutron scattering,crystal fields,data analysis
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: numpy
Requires-Dist: scipy
Dynamic: license-file

Introduction
============
CFcal is a Python package for performing calculations of crystal field (CF) 
properties of rare earth ions using the Stevens Operator formalism [K. W. H. 
Stevens, Proc. Phys. Soc. A **65**, 209 (1952)]. Once the CF parameters have 
been initialized, the CF Hamiltonian can be diagonalized to determine the 
energies and wavefunctions of all the CF levels. These can be used to determine
the magnetic susceptibility and neutron scattering spectra as a function of 
temperature.

Installing and Running
======================
CFcal requires Python 3.10 or later.

The easiest way to install CFcal is from PyPI:

```
    $ pip install cfcal
```

Alternatively, the latest development version can be installed from the CFcal
[Git repository](https://github.com/rayosborn/cfcal):

```
    $ git clone https://github.com/rayosborn/cfcal.git
    $ cd cfcal
    $ pip install .
```
