Guides and Tutorials
This is the main landing page for the AntennaCAT guides and tutorial collection. Refer to the Table of Contents below for current topics and reference materials.
For Documentation, see the main Documentation page. This is an archive of grouped tutorials and references, not the primary documentation.
Table of Contents
- Release Version Notes
- Using Simulation Software with AntennaCAT
- Getting Started
- Downloading and Running AntennaCAT
- Using AntennaCAT
- Working with AntennaCAT Code
- Video Tutorials
- Other References
Information on past and current versions of AntennaCAT are available on the Documents page.
Refer to the official release notes on the Documents page for the current integration progress.
AntennaCAT does NOT provide access or licenses to compatible EM simulation software suites. Licenses must be purchased by the user (or university, business, etc.)
AntennaCAT may run on clusters or remote servers depending on your individual setup. However, there are two things that work against this:
- AntennaCAT is a GUI-based application, so it is not designed to run on a headless/terminal-based setup.
- Some EM simulation software suites require specific licenses to be used for clusters, and AntennaCAT has not been tested nor designed for these.
You are welcome to experiment, or add your own functionality to AntennaCAT, but these features are not currently natively supported or in development.
Full instructions on how to Download and Run AntennaCAT are on the Getting Started Guide.
For more specific guides and tutorials, refer to subsections on this page.
Full instructions on how to Download and Run AntennaCAT are on the Getting Started Guide.
If you don't have a GitHub account, you can still download the code as a .zip folder and open it in your favorite IDE.
- If you aren't sure what an IDE is, please refer to this section in the Getting Started Guide.
If you aren't sure how to set up an IDE with Python or install requirements, refer to our Getting Started Guide:
- Working with Python
- An example for setting up and configuring Visual Studio Code
If you need help importing downloaded code into the IDE:
- See the 'importing project code' in the Download and Run AntennaCAT section.
The simplified project structure is shown below. Full file structure will be updated in the documentation for future collaboration efforts.
.
├── AntennaCalculationAndAutotuning
|
├── .src # dir for source code of AntennaCAT
│ │
│ ├── ... # root of the project code.
│ │
│ └── main.py # main program file. The project entry point.
|
├── README.md # this README
└── requirements.txt #project requirement minimumAntennaCAT and derivatives should be run from main.py, either in an IDE or with the command 'python main.py' in a terminal.
While there are unit testing artifacts in some code files, entry at other points in the program will cause some features to not work.
It is recommended to run AntennaCAT in a virtual environment, but it is not a requirement.
Under construction!
Under construction!