https://github.com/alaweimm90/spincirc

MATLAB/Cadence-based scalable stochastic simulator for modeling multistate spin-based logic and device architectures with SPICE-compatible integration

https://github.com/alaweimm90/spincirc

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

MATLAB/Cadence-based scalable stochastic simulator for modeling multistate spin-based logic and device architectures with SPICE-compatible integration

Basic Info
  • Host: GitHub
  • Owner: alaweimm90
  • License: mit
  • Language: MATLAB
  • Default Branch: main
  • Homepage:
  • Size: 368 KB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created 7 months ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Citation

.github/README-shortcuts.md

Git Repository Shortcuts

✅ Installation Complete!

Universal Git workflow shortcuts have been installed and are ready to use.

🎯 Available Commands

After opening a new terminal (to load PATH), you can use these commands in any Git repository:

```bash

Before Claude Code session

repo-start # Pull latest changes and check status

After Claude Code session

repo-review # Review all changes made repo-stage-all # Stage all changes for commit repo-save "msg" # Stage all + commit + push in one command

Utilities

repo-help # Show help and workflow guide ```

💡 Typical Workflow

  1. Navigate to your repository: bash cd /path/to/your/repo

  2. Before opening Claude Code: bash repo-start

  3. Use Claude Code (make your changes)

  4. After Claude Code session: bash repo-review # See what changed repo-save "Add new features" # Save everything

🔧 Manual Commands (if shortcuts don't work)

If the shortcuts aren't available, use these manual commands:

```bash

Before Claude

cd /path/to/your/repo git pull origin main git status

After Claude

git status # See changes git add . # Stage all changes git commit -m "Your message" # Commit changes git push origin main # Push to GitHub ```

🌟 Features

  • Universal: Works in any Git repository
  • Automatic: Handles main/master branch detection
  • Safe: Always shows status before major operations
  • Claude-Clean: Your Git hook prevents Claude attribution

🔄 Loading Scripts

The shortcuts are added to your ~/.bashrc and will be available in new terminal sessions. If they don't work immediately:

bash source ~/.bashrc

Or use the direct paths: bash /mnt/c/Users/mesha/Documents/GitHub/SpinCirc/repo-help


Ready for Claude Code sessions with clean, organized Git workflows! 🚀

Owner

  • Login: alaweimm90
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
title: "SpinCirc: Advanced Spin Transport Circuit Framework"
version: 1.0.0
doi: 10.5281/zenodo.spincirc-v1.0.0
date-released: 2025-01-31
url: "https://github.com/alaweimm90/SpinCirc"
repository-code: "https://github.com/alaweimm90/SpinCirc"
repository-artifact: "https://github.com/alaweimm90/SpinCirc/releases"
abstract: >-
  SpinCirc is a comprehensive MATLAB/Python/Verilog-A framework 
  implementing the equivalent-circuit spin-transport formalism for 
  computational spintronics research. It features 4×4 conductance 
  matrix formalism, time-dependent drift-diffusion solvers, and 
  advanced magnetodynamics with LLG/LLGS integration.
authors:
  - family-names: "Alawein"
    given-names: "Dr. Meshal"
    email: "meshal@berkeley.edu"
    affiliation: "University of California, Berkeley"
    orcid: "https://orcid.org/0000-0000-0000-0000"
    website: "https://malawein.com"
license: MIT
keywords:
  - "spintronics"
  - "computational physics"
  - "spin transport"
  - "magnetization dynamics"
  - "device modeling"
  - "LLG equation"
  - "Berkeley"
  - "quantum computing"
  - "materials science"
  - "MATLAB"
  - "Python"
  - "Verilog-A"
references:
  - type: article
    authors:
      - family-names: "Alawein"
        given-names: "Meshal"
      - family-names: "Fariborzi"
        given-names: "Hamid"
    title: "Circuit Models for Spintronic Devices Subject to Electric and Magnetic Fields"
    journal: "IEEE Journal on Exploratory Solid-State Computational Devices and Circuits"
    volume: 4
    issue: 2
    start: 76
    end: 85
    year: 2018
    publisher: "IEEE"
    doi: 10.1109/JXCDC.2018.2848670
preferred-citation:
  type: article
  authors:
    - family-names: "Alawein"
      given-names: "Meshal"
    - family-names: "Fariborzi"
      given-names: "Hamid"
  title: "Circuit Models for Spintronic Devices Subject to Electric and Magnetic Fields"
  journal: "IEEE Journal on Exploratory Solid-State Computational Devices and Circuits"
  volume: 4
  issue: 2
  start: 76
  end: 85
  year: 2018
  publisher: "IEEE"
  doi: 10.1109/JXCDC.2018.2848670

GitHub Events

Total
  • Push event: 6
  • Pull request review event: 2
  • Pull request event: 3
  • Create event: 3
Last Year
  • Push event: 6
  • Pull request review event: 2
  • Pull request event: 3
  • Create event: 3

Dependencies

.github/workflows/ci.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • aquasecurity/trivy-action master composite
  • codecov/codecov-action v3 composite
  • docker/build-push-action v5 composite
  • docker/login-action v3 composite
  • docker/metadata-action v5 composite
  • docker/setup-buildx-action v3 composite
  • dorny/test-reporter v1 composite
  • github/codeql-action/upload-sarif v3 composite
  • matlab-actions/run-command v2 composite
  • matlab-actions/run-tests v2 composite
  • matlab-actions/setup-matlab v2 composite
  • peaceiris/actions-gh-pages v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
  • softprops/action-gh-release v1 composite
.github/workflows/codeql.yml actions
  • actions/checkout v4 composite
  • github/codeql-action/analyze v3 composite
  • github/codeql-action/autobuild v3 composite
  • github/codeql-action/init v3 composite
.github/workflows/github-workflows.yml actions
  • actions/cache v3 composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • codecov/codecov-action v3 composite
  • docker/build-push-action v4 composite
  • docker/login-action v2 composite
  • docker/metadata-action v4 composite
  • docker/setup-buildx-action v2 composite
  • matlab-actions/run-command v2 composite
  • matlab-actions/run-tests v2 composite
  • matlab-actions/setup-matlab v2 composite
  • peaceiris/actions-gh-pages v3 composite
  • softprops/action-gh-release v1 composite
Dockerfile docker
  • base latest build
  • matlab-env latest build
  • python-env latest build
  • ubuntu 22.04 build
docker-compose.yml docker
  • spincirc latest
python/requirements.txt pypi
  • black >=21.6.0
  • bokeh >=2.4.0
  • click >=8.0.0
  • configparser >=5.0.0
  • cython >=0.29.0
  • flake8 >=3.9.0
  • h5py >=3.3.0
  • ipywidgets >=7.6.0
  • isort >=5.9.0
  • jupyter >=1.0.0
  • jupyterlab >=3.0.0
  • matplotlib >=3.5.0
  • mypy >=0.910
  • myst-parser >=0.15.0
  • netCDF4 >=1.5.7
  • nlopt >=2.7.0
  • notebook >=6.4.0
  • numba >=0.53.0
  • numpy >=1.21.0
  • optuna >=2.10.0
  • pandas >=1.3.0
  • plotly >=5.0.0
  • pre-commit >=2.13.0
  • pytest >=6.2.0
  • pytest-cov >=2.12.0
  • pyyaml >=5.4.0
  • scikit-image >=0.18.0
  • scikit-learn >=1.0.0
  • scipy >=1.7.0
  • seaborn >=0.11.0
  • sphinx >=4.0.0
  • sphinx-copybutton >=0.4.0
  • sphinx-rtd-theme >=0.5.0
  • sphinxcontrib-matlab >=0.17.0
  • statsmodels >=0.12.0
  • toml >=0.10.0
  • tqdm >=4.61.0
setup.py pypi