Frequently Asked Questions (FAQ)¶
Installation and Setup¶
How do I install LayerLumos?¶
LayerLumos can be installed by cloning our GitHub repository and following the setup instructions in the README. Ensure you have the necessary dependencies installed before running the software.
What are the system requirements for LayerLumos?¶
LayerLumos requires Python 3.6 or higher and works on Windows, macOS, and Linux. Specific library dependencies are listed in the requirements.txt
file.
Usage¶
How do I perform a basic RT calculation?¶
After installing LayerLumos, you can perform a basic RT calculation by running the provided example scripts or by using the LayerLumos API in your Python scripts. Check the Quick Start Guide in the README for more details.
Can LayerLumos simulate RT for any angle of incidence?¶
Yes, LayerLumos supports simulations for any angle of incidence. Users can specify the angle in the simulation parameters.
How do I add new materials to the material database?¶
To add a new material, you can edit the materials.json
file and include the optical properties of your material. Please refer to the documentation for the required data format.
Troubleshooting¶
I’m getting an error when trying to run a simulation. What should I do?¶
Ensure that all dependencies are correctly installed and that your Python environment is set up properly. Check the error message for hints on what might be wrong. If the problem persists, please file an issue on our GitHub page with details of the error.
The simulation results seem off. How can I verify them?¶
Double-check the input parameters for your simulation, including material indices, layer thicknesses, and frequency vector. Compare your results with known values or simpler cases to verify accuracy.
Contribution and Support¶
How can I contribute to LayerLumos?¶
We welcome contributions in the form of bug reports, feature requests, and pull requests. Please refer to our CONTRIBUTING.md file for guidelines on how to contribute.
Where can I ask questions or seek support?¶
If you have questions or need support, you can open an issue on our GitHub repository or contact us via the details provided in the README. We also have a community forum (if applicable) where you can seek help from other users.